|
1 | 1 |
|
| 2 | +# Contributing to Geminate |
| 3 | + |
| 4 | +Firstly, thank you for considering contributing and thus improving geminate 🙏 |
| 5 | + |
| 6 | +All contributions are **welcome**.If you want to fix a bug or improve this project, create an issue or discussion. <br> |
| 7 | + |
| 8 | + |
| 9 | +## How to Contribute |
| 10 | + |
| 11 | +### 1. Fork the repository |
| 12 | + |
| 13 | +- Go to the repository page and click the "Fork" button at the top right. |
| 14 | + |
| 15 | +### 2. Clone the repository |
| 16 | + |
| 17 | +- Clone your fork to your local machine using: |
| 18 | +- **Make sure you replace YOUR-USERNAME with your github username** |
| 19 | + |
| 20 | +```sh |
| 21 | +git clone https://github.com/YOUR-USERNAME/geminate |
| 22 | +``` |
| 23 | + |
| 24 | +### 3. Create a new branch |
| 25 | + |
| 26 | +- Create a new branch for your feature or fix: |
| 27 | + |
| 28 | +```sh |
| 29 | +git checkout -b your-branch-name |
| 30 | +``` |
| 31 | + |
| 32 | +### 4. Make your changes |
| 33 | + |
| 34 | +- Make your changes and write clear, concise commit messages. |
| 35 | +- If you’re fixing a bug or adding a feature, please ensure you write tests where applicable. |
| 36 | + |
| 37 | +### 5. Commit your changes |
| 38 | + |
| 39 | +- Stage and commit your changes. |
| 40 | + |
| 41 | +```sh |
| 42 | + git add . |
| 43 | + git commit -m "Description of your changes" |
| 44 | +``` |
| 45 | + |
| 46 | +### 6. Push your fork |
| 47 | + |
| 48 | +- Push your changes back to your fork on GitHub: |
| 49 | + |
| 50 | +```sh |
| 51 | + git push origin your-branch-name |
| 52 | +``` |
| 53 | + |
| 54 | +### 7 Create a pull request |
| 55 | + |
| 56 | +- Open a pull request against the main branch of the repository with a description of the changes you've made. |
| 57 | + |
| 58 | +## Code of Conduct |
| 59 | + |
| 60 | +By participating in this project, you agree to adhere to the [Code of Conduct](https://g.yxqyang.asia.geminate/CODE_OF_CONDUCT.md). |
| 61 | + |
| 62 | +## Reporting Issues |
| 63 | + |
| 64 | +If you encounter any bugs or issues, please open an issue on the Issues page. Be sure to include the steps to reproduce and any relevant information, such as your environment and error messages. |
| 65 | + |
| 66 | +## Questions? |
| 67 | + |
| 68 | +Feel free to ask questions via the issues section or reach out if you need any help getting started with the project! |
| 69 | + |
0 commit comments