The Wayback Machine - https://web.archive.org/web/20200522031338/https://github.com/nestjs/nest/issues/3272
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

Improve CONTRIBUTING.md #3272

Open
jmcdo29 opened this issue Oct 25, 2019 · 3 comments
Open

Improve CONTRIBUTING.md #3272

jmcdo29 opened this issue Oct 25, 2019 · 3 comments

Comments

@jmcdo29
Copy link
Member

@jmcdo29 jmcdo29 commented Oct 25, 2019

I'm submitting a...


[ ] Regression 
[ ] Bug report
[ ] Feature request
[X] Documentation issue or request (new chapter/page)
[ ] Support request => Please do not submit support request here, instead post your question on Stack Overflow.

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 link or 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.

@kamilmysliwiec
Copy link
Member

@kamilmysliwiec kamilmysliwiec commented Oct 27, 2019

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 CONTRIBUTING.md files.

@jmcdo29
Copy link
Member Author

@jmcdo29 jmcdo29 commented Oct 27, 2019

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?

@kamilmysliwiec
Copy link
Member

@kamilmysliwiec kamilmysliwiec commented Oct 27, 2019

Let me move this issue. PRs are more than welcome :)

@kamilmysliwiec kamilmysliwiec transferred this issue from nestjs/docs.nestjs.com Oct 27, 2019
@kamilmysliwiec kamilmysliwiec changed the title Add a Contributing Section Improve CONTRIBUTING.md Nov 3, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
You can’t perform that action at this time.