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

Add a CONTRIBUTING.md file #10

Open
kieran-ryan opened this issue Jun 18, 2023 · 0 comments
Open

Add a CONTRIBUTING.md file #10

kieran-ryan opened this issue Jun 18, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@kieran-ryan
Copy link
Owner

A CONTRIBUTING.md file is an important element of every repository. It provides visitors with an overview of how they can set up, work with and contribute to the repository. Writing this documentation, also provides repository owners with a useful opportunity to assess usability issues and to examine the project from a fresh perspective, with a mindset of 'What issues might someone seeing this for the first time encounter?' or 'Is there any way I could make this implementation more explicit and reduce its "unknown unknowns"?'.

As this is a template that will form the basis of other repositories, it is important that it provides a well-documented contributing guide that captures questions and issues that a new visitor may encounter. This will allow them to act with autonomy and to not be dependant on direct support and answers from the original authors.

@kieran-ryan kieran-ryan added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jun 18, 2023
@kieran-ryan kieran-ryan changed the title Add a CONTRIBUTING.md file to the repository Add a CONTRIBUTING.md file Jul 1, 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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant