|
| 1 | +# Contribution Guide |
| 2 | + |
| 3 | +Thank you for your interest in contributing to this project! Your contributions can help make this project better. Here are some guidelines to help you get started. |
| 4 | + |
| 5 | +## How to Contribute |
| 6 | + |
| 7 | +1. Fork this repository: |
| 8 | + - Click the `Fork` button at the top of this repository page. |
| 9 | +2. Clone the forked repository to your local machine. |
| 10 | + ```bash |
| 11 | + git clone https://github.com/username/Log-Rift.git |
| 12 | + ``` |
| 13 | + - Replace `username` with your GitHub username. |
| 14 | +3. Create a new branch |
| 15 | + - Create a new branch for the feature or fix you want to add. |
| 16 | + ``` |
| 17 | + cd Log-Rift |
| 18 | + git checkout -b your-branch-name |
| 19 | + ``` |
| 20 | + - Use a descriptive branch name that reflects the feature or fix you are working on. |
| 21 | +4. Make the necessary changes: |
| 22 | + - Add or modify your code. |
| 23 | +5. Commit your changes: |
| 24 | + - Make sure to write a clear and descriptive commit message. |
| 25 | + ``` |
| 26 | + git add . |
| 27 | + git commit -m "Brief description of the changes you made" |
| 28 | + ``` |
| 29 | +6. Push to your repository: |
| 30 | + - Push your branch to your GitHub repository. |
| 31 | + ``` |
| 32 | + git push origin your-branch-name |
| 33 | + ``` |
| 34 | +7. Create a Pull Request (PR): |
| 35 | + - Go to the original repository page and create a pull request from your branch. |
| 36 | + - Provide a clear description of what you added or fixed in your pull request. |
| 37 | + |
| 38 | +## Coding Guidelines |
| 39 | + |
| 40 | +- Follow a consistent coding standard: Ensure your code is consistent with the existing code style in this project. |
| 41 | +- Write clear documentation: Add necessary comments and documentation to help others understand your code. |
| 42 | +- Write tests: If possible, add tests for the features or fixes you are adding. |
| 43 | + |
| 44 | +## Reporting Issues |
| 45 | + |
| 46 | +If you find any bugs or have suggestions for improvements, please create a new issue on the Issues page. |
| 47 | + |
| 48 | +## Communication |
| 49 | + |
| 50 | +If you want to discuss something related to your contribution or the project in general, feel free to reach out to us via [Discussions](https://github.com/sha-wrks/Log-Rift/discussions). |
| 51 | + |
| 52 | +<br> |
| 53 | +Thank you for your contribution! |
0 commit comments