GH #12 - Added Contribution Guidelines in CONTRIBUTING.md #27
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
DuaneOBrien
suggested changes
Oct 8, 2020
| ## Unit Tests | ||
|
|
||
| All changes submitted must include updated unit tests (excluding documentation and configuration changes). | ||
| In order for your change to be accepted, the [TravisCI](https://travis-ci.com/indeedeng/cluster-preset) pipeline must complete successfully. |
There was a problem hiding this comment.
Looking through the existing repo it doesn't look like there are many unit tests for the other parts of the code, and I don't think adding test here will kick off the travis pipeline. We could probably keep the unit tests requirement but drop the travis pipeline sentence.
|
|
||
| ## Code of Conduct | ||
|
|
||
| ClusterPreset is governed by the [Contributor Covenant v1.4.1](CODE_OF_CONDUCT.md). |
There was a problem hiding this comment.
Could just changes this to say "This project" rather than ClusterPreset
| The general process for contributing code is as follows: | ||
|
|
||
| 1. Open an issue describing the desired feature, bug fix, or improvement you'd like to see before making any changes. | ||
| 2. Assign the ticket to yourself, and/or leave a comment on the issue that you would like to work on it. |
There was a problem hiding this comment.
The contributor should wait for confirmation from the project before starting work, as this one isn't rigorously maintained.
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.
GH #12 - Added Contribution Guidelines in CONTRIBUTING.md