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

Development documentation #500

Open
javierbrea opened this issue May 21, 2024 · 0 comments
Open

Development documentation #500

javierbrea opened this issue May 21, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@javierbrea
Copy link
Member

Development documentation should be added to the website. It shouldn't consist only in the typical "How to contribute" guide explaining how to open a PR and a fast style guide, such as the one that the project currently has.
It should be complete enough to make easy to contribute in the code to anyone that may be interested. So, it should include chapters like:

  • Installation
  • Repo structure
  • How to run unit tests
  • How to run component tests
  • Development tools, such as Nx, Pnpm, etc. Including versions to install, how to, etc.
  • Code style guides to everything not covered by linters, and also chapter about how to run linters locally, how to configure IDEs properly, git hooks, etc.
  • How to update documentation, including a style guide.
  • Style guide for writing tests: Types of tests, schemas about how they work, etc.
  • Style guide for writing documentation
  • Branching model and release workflow description and schemas
@javierbrea javierbrea added the documentation Improvements or additions to documentation label May 21, 2024
@javierbrea javierbrea added this to the 5.0.0 milestone May 21, 2024
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
Projects
Status: Todo
Development

No branches or pull requests

1 participant