37 lines
1.1 KiB
Markdown
37 lines
1.1 KiB
Markdown
# Contributing to the Project
|
|
|
|
Thank you for considering contributing to our project! We welcome contributions from everyone. Here are some guidelines to help you get started.
|
|
|
|
## How to Contribute
|
|
|
|
1. **Fork the Repository**: Fork the repo on GitHub and clone it to your local machine.
|
|
|
|
```bash
|
|
git clone https://github.com/your-username/your-repo.git
|
|
cd your-repo
|
|
```
|
|
|
|
2. **Create a Branch**: Create a new branch for your feature or bug fix.
|
|
|
|
````bash
|
|
git checkout -b my-feature-branch
|
|
````
|
|
3. **Make Changes**: Make your changes in your branch.
|
|
|
|
4. **Commit Changes**: Commit your changes with a descriptive commit message.
|
|
|
|
````bash
|
|
git add . git commit -m "Add feature X"
|
|
````
|
|
5. **Push to GitHub**: Push your changes to GitHub.
|
|
````bash
|
|
git push origin my-feature-branch
|
|
````
|
|
|
|
6. **Create a Pull Request**: Open a pull request on GitHub from your forked repository.
|
|
|
|
|
|
## Code Style
|
|
|
|
Please follow the coding standards used throughout the project. If you are unsure, you can refer to the existing codebase.
|