This repository was archived by the owner on Dec 13, 2024. It is now read-only.
This repository was archived by the owner on Dec 13, 2024. It is now read-only.
[DOCS] End-to-end documentation #8
Description
Project requires a good guide on several topics so that new developers can contribute to the project
- Create a good README file that includes project information, installation instructions, usage guidelines, and contribution guidelines.
- Keep an eye on the repo and regularly update the README file to reflect changes in the project, new features, or updates.
- Create Changelog file establish a changelog file to document changes made in each release.(Low priority for now).
- Developer Documentation (Guide + Setup).Document the project's code structure and organization to help developers navigate the codebase.
- Contribution Guidelines
- Contribution Process
- Document the process for contributing to the project, including how to submit bug reports, feature requests, and pull requests. Provide a code style guide to maintain consistency in the codebase.