docs: Create Contribution Guidelines #49
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ScottBrenner
added
documentation
ScottBrenner
commented
Apr 24, 2021
NickLiffen
reviewed
Apr 25, 2021
NickLiffen
reviewed
Apr 25, 2021
NickLiffen
reviewed
Apr 25, 2021
|
I think in the Issue Template we need to ask some more specific questions such as:
I think they would be useful 👍 |
|
@ScottBrenner thoughts on increasing the scope of this pull request to the following: |
ScottBrenner
changed the title
|
Added a bunch of things from https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions, most of it's automatically generated - open to changing the wordings. |
|
@ScottBrenner Content looks really good 👍 If you have this locally, you just need to run: This will fix the failing tests. It is failing due to |
|
Whoops, think a484aa6 fixed it? 😵 |
ScottBrenner
commented
Apr 25, 2021
| **Screenshots** | ||
| If applicable, add screenshots to help explain your problem. | ||
|
|
||
| **GitHub Actions Runner configuration (please complete the following information):** |
There was a problem hiding this comment.
Suggested change
| **GitHub Actions Runner configuration (please complete the following information):** | |
| **GitHub Actions job configuration (please complete the following information):** |
Not sure what the correct terminology is here, but we want details of the environment that the Action is running in
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
| reported to the community leaders responsible for enforcement at | ||
| [email protected]. |
There was a problem hiding this comment.
A contact method was required here, when generating the file thru GitHub
| @@ -0,0 +1,9 @@ | |||
| ## Contributing | |||
|
|
|||
| This product welcomes contributions the any open source community. Firstly, please raise an issue on the repository, as this will be used to discuss/agree on scope and feature/bug detail. Once agreed, please follow the [Running Locally](#running-locally) steps above to get started on your machine. Branch off `main` following logically branch naming conventions `feature/***` or `bug/***`. When contributing please try and meet these development principles: | |||
There was a problem hiding this comment.
Suggested change
| This product welcomes contributions the any open source community. Firstly, please raise an issue on the repository, as this will be used to discuss/agree on scope and feature/bug detail. Once agreed, please follow the [Running Locally](#running-locally) steps above to get started on your machine. Branch off `main` following logically branch naming conventions `feature/***` or `bug/***`. When contributing please try and meet these development principles: | |
| This product welcomes contributions the any open source community. Firstly, please raise an issue on the repository, as this will be used to discuss/agree on scope and feature/bug detail. Once agreed, please follow the Development section's steps in [README.md](README.md) to get started. Branch off `main` following logically branch naming conventions `feature/***` or `bug/***`. When contributing please try and meet these development principles: |
NickLiffen
previously approved these changes
Apr 26, 2021
ScottBrenner
force-pushed
the
feat/issue-templates
branch
from
a484aa6 to
d27e5e6
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adding most things from https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions.