Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upImprove CONTRIBUTING.md #3272
Open
Improve CONTRIBUTING.md #3272
Labels
Comments
|
I think that we should just update https://github.com/nestjs/nest/blob/master/CONTRIBUTING.md file to keep all advices/hints/info in one single place. Adding a dedicated chapter to the docs doesn't make too much sense. Similarly, Angular has contribute page which simply contains links to the corresponding |
|
Fair enough. Should the PR be made against the main repository and I'll let you handle spreading it to the others, or should want repo get their own PR? |
|
Let me move this issue. PRs are more than welcome :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment


I'm submitting a...
Current behavior
There is no Contributing Section
Expected behavior
There is a section in the docs about contributing.
What is the motivation / use case for changing the behavior?
After recently picking up a small ticket to help contribute to NestJS I had to reach out to members of the core team about how to test changes and see how things can be done. There were overall, a couple of hoops I had to jump through (or so it felt) to make sure that I could play with the changes I was currently making. I figured having a section in the docs, maybe under the FAQ section, could help those of us who want to get into helping with this amazing framework and it can point out a couple of practices that should be used when contributing (i.e. using
npm linkor creating a sample project in an ignored directory, how to run all tests, etc.)This may also be a good way to help more people feel less intimidated by Nest, as it is a large project with a really complex backend.
Others:
As I recently went through contributing I would definitely be willing to help point out pain points I encountered and help make the docs more clear for other beginners.