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.

Sign up for GitHub

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

Jump to bottom

Improve CONTRIBUTING.md #107

Closed
audreyfeldroy opened this issue Aug 24, 2021 · 2 comments
Closed

Improve CONTRIBUTING.md #107

audreyfeldroy opened this issue Aug 24, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@audreyfeldroy
Copy link
Member

Let's make CONTRIBUTING.md more newbie-friendly. This issue involves improving that file with things like:

  • What are some lessons you learned while contributing to this project?
  • Anything that would help new contributors get started?
  • What are common errors newbies face? Perhaps those could go into a Troubleshooting section?
  • Are there parts of README.md that would be better in CONTRIBUTING.md, or vice versa?
@audreyfeldroy audreyfeldroy added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Aug 24, 2021
@RedFox0x20
Copy link
Collaborator

RedFox0x20 commented Aug 24, 2021 •
edited

I'd be happy to start improving the repository documentation, including elements of the community tab.

Feel free to expand upon my changes. I'm sure someone has more experience writing these docs than I.

@RedFox0x20 RedFox0x20 mentioned this issue Aug 24, 2021
Merged
@audreyfeldroy
Copy link
Member Author

I'll close this because #109 addressed it so well, but I'm always so open to improving CONTRIBUTING.md as well as the other community docs. The friendlier and kinder, the better. Improvements are always welcome.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@audreyfeldroy @RedFox0x20