|
| 1 | +# Contributing |
| 2 | + |
| 3 | +[fork]: https://github.com/IBM/python-versions-pz/fork |
| 4 | + |
| 5 | +We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great. |
| 6 | + |
| 7 | +Contributions to this project are welcome under the [Apache](LICENSE) license. |
| 8 | + |
| 9 | +## Contents |
| 10 | +- [Submitting a pull request](#submitting-a-pull-request) |
| 11 | +- [Code style guide (coming soon!)](#code-style-guide) |
| 12 | + |
| 13 | +## Submitting a pull request |
| 14 | + |
| 15 | +1. [Fork][fork] and clone the repository. |
| 16 | +2. Create a new branch: `git checkout -b my-branch-name`. |
| 17 | +3. Make your changes, ensuring that they include steps to install and validation post-install |
| 18 | +4. Test your changes by creating and deploying the image |
| 19 | +5. Push to your fork and [submit a pull request][pr]. |
| 20 | + |
| 21 | +### Commit Messages |
| 22 | + |
| 23 | +__All commit messages must include a Sign-off line__ |
| 24 | + |
| 25 | +Please consider out commit message standards in order for your contribution to be merged into the main branch. |
| 26 | + |
| 27 | +#### Subject Line |
| 28 | +* __Conciseness__: Limit the subject line to around 50 characters to ensure readability in various Git tools. |
| 29 | +* __Imperative Mood__: Use the imperative mood, as if giving a command. For example, "Fix bug" instead of "Fixed bug" or "Fixes bug." |
| 30 | +* __Capitalization__: Capitalize the first letter of the subject line. |
| 31 | +* __No Period__: Do not end the subject line with a period. |
| 32 | +* __Clarity__: Summarize the core change or purpose of the commit clearly and directly. |
| 33 | + |
| 34 | +#### Body (Optional but highly recommended) |
| 35 | +* __Separate from Subject__: Leave a blank line between the subject line and the body. |
| 36 | +* __Explain "What" and "Why"__: Detail what changes were made and, more importantly, why those changes were necessary. Focus on the problem solved or the feature implemented, rather than the specific implementation details (the "how"). |
| 37 | +* __Wrap Lines__: Wrap body lines at approximately 72 characters for better readability. |
| 38 | +* __Provide Context__: Include any relevant context, such as links to issues, bug reports, or design documents, if applicable. |
| 39 | +* __Explain Side Effects__: Note any potential side effects or non-obvious consequences of the changes. |
| 40 | + |
0 commit comments