Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] End-to-end documentation #8

Open
zakhaev26 opened this issue Dec 18, 2023 · 0 comments
Open

[DOCS] End-to-end documentation #8

zakhaev26 opened this issue Dec 18, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation not-assigned P-medium

Comments

@zakhaev26
Copy link
Member

zakhaev26 commented Dec 18, 2023

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.
@zakhaev26 zakhaev26 added documentation Improvements or additions to documentation not-assigned P-medium labels Dec 18, 2023
@zakhaev26 zakhaev26 changed the title End-to-end documentation [DOCS] End-to-end documentation Dec 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation not-assigned P-medium
Projects
None yet
Development

No branches or pull requests

1 participant