Create CONTRIBUTING.md #1881
Merged
Create CONTRIBUTING.md #1881
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
Add a contributing page. Will link from main readme when added
|
It would be nice to add or link to something that mentions running tests locally before submitting them for a PR. Ideally, that would just be via a tox command which runs the tests we consider 'default' for all PRs. Until we land #1825 there isn't a tox, so either we land that and adjust tox as necessary or document what the current expectation is and update it when we do have tox setup. |
|
@ktsakalozos do you want to add whatever testing needs to be done here, or explain it to me so I can finish this up? |
|
@evilnick @chris-sanders just added a section on how to run the tests currently with pytest, we can revise this as soon as the tox based testing is merged. Also added a PR template. |
|
@ktsakalozos Thanks! 👍 |
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.
Add a contributing page. Will link from main readme when added