| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
1 parent 53bca1a commit 1b31526
1 file changed
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,40 @@ | |||
| 1 | + # How to contribute | ||
| 2 | + | ||
| 3 | + PythonNet is developed and maintained by unpaid community members so well | ||
| 4 | + written, documented and tested pull requests are encouraged. | ||
| 5 | + | ||
| 6 | + ## Getting Started | ||
| 7 | + | ||
| 8 | + * Make sure you have a [GitHub account](https://github.com/signup/free) | ||
| 9 | + * Submit a ticket for your issue, assuming one does not already exist. | ||
| 10 | + * Clearly describe the issue including steps to reproduce when it is a bug. | ||
| 11 | + * Make sure you include what Python version and operating system you are using. | ||
| 12 | + * Fork the repository on GitHub | ||
| 13 | + | ||
| 14 | + ## Making Changes | ||
| 15 | + | ||
| 16 | + * Create a topic branch from where you want to base your work. | ||
| 17 | + * This is usually the develop branch. | ||
| 18 | + * Only target release branches if you are certain your fix must be on that | ||
| 19 | + branch. | ||
| 20 | + * To quickly create a topic branch based on develop; `git checkout -b | ||
| 21 | + fix/develop/my_contribution develop`. Please avoid working directly on the | ||
| 22 | + `master` branch. | ||
| 23 | + * Make commits of logical units. | ||
| 24 | + * Check for unnecessary whitespace with `git diff --check` before committing. | ||
| 25 | + * Make sure your commit messages are in the proper format. | ||
| 26 | + * Make sure you have added the necessary tests for your changes. | ||
| 27 | + * Run _all_ the tests to assure nothing else was accidentally broken. | ||
| 28 | + | ||
| 29 | + | ||
| 30 | + ## Submitting Changes | ||
| 31 | + | ||
| 32 | + * Push your changes to a topic branch in your fork of the repository. | ||
| 33 | + * Submit a pull request to the repository in the puppetlabs organization. | ||
| 34 | + * After feedback has been given we expect responses within two weeks. After two | ||
| 35 | + weeks we may close the pull request if it isn't showing any activity. | ||
| 36 | + | ||
| 37 | + # Additional Resources | ||
| 38 | + | ||
| 39 | + * [General GitHub documentation](https://help.github.com/) | ||
| 40 | + * [GitHub pull request documentation](https://help.github.com/send-pull-requests/) | ||
| Back | FazBrowse Home | New Git URL |
0 commit comments