|
| 1 | +# Contributing to JsWeb. |
| 2 | + |
| 3 | +First off, thank you for considering contributing. It's people like you that make open-source such a great community. Any contributions you make are **greatly appreciated**. |
| 4 | + |
| 5 | +## How to Contribute |
| 6 | + |
| 7 | +We use a standard workflow for contributions. If you have an improvement, please follow these steps: |
| 8 | + |
| 9 | +1. **Fork the Project** |
| 10 | + * Click the "Fork" button at the top right of the repository page. This creates a copy of the project in your own GitHub account. |
| 11 | + |
| 12 | +2. **Create a New Branch** |
| 13 | + * From your forked repository, create a new branch to work on your feature or bug fix. |
| 14 | + * `git checkout -b feature/MyAmazingFeature` or `git checkout -b fix/MyBugFix` |
| 15 | + |
| 16 | +3. **Make Your Changes and Commit** |
| 17 | + * Write your code and make sure to add comments and docstrings where necessary. |
| 18 | + * Commit your changes with a clear and descriptive commit message. |
| 19 | + * `git commit -m 'feat: Add some AmazingFeature'` |
| 20 | + |
| 21 | +4. **Push to Your Branch** |
| 22 | + * Push your committed changes to your forked repository on GitHub. |
| 23 | + * `git push origin feature/MyAmazingFeature` |
| 24 | + |
| 25 | +5. **Open a Pull Request** |
| 26 | + * Go to the original repository and you will see a prompt to create a Pull Request from your new branch. |
| 27 | + * Provide a clear title and description for your changes, explaining what you've added or fixed. |
| 28 | + |
| 29 | +## Reporting Bugs |
| 30 | + |
| 31 | +If you find a bug, please create an issue on the GitHub repository. When you do, please include: |
| 32 | + |
| 33 | +* Your version of jsweb and Python. |
| 34 | +* A clear and concise description of the bug. |
| 35 | +* The exact steps needed to reproduce the issue. |
| 36 | +* Any relevant code snippets that cause the bug. |
| 37 | + |
| 38 | +## Suggesting Enhancements |
| 39 | + |
| 40 | +If you have an idea for a new feature, please open an issue to discuss it. This lets us track the suggestion and allows others to chime in. In your issue, please provide: |
| 41 | + |
| 42 | +* A clear description of the feature. |
| 43 | +* An explanation of the problem this feature would solve. |
| 44 | +* A code example or use-case, if possible. |
| 45 | + |
| 46 | +Thank you again for your contribution! |
0 commit comments