59 lines
2.2 KiB
Markdown
59 lines
2.2 KiB
Markdown
# Contributing to ras-pi
|
|
|
|
We welcome contributions to ras-pi! Whether you're fixing a bug, proposing a feature, or improving documentation, your help is appreciated.
|
|
|
|
## How to Contribute
|
|
|
|
1. **Fork the repository:** Click the "Fork" button at the top right of the page. This creates a copy of the repository in your GitHub account.
|
|
2. **Clone your fork:** Clone the repository to your local machine using Git:
|
|
|
|
```bash
|
|
git clone [https://github.com/YOUR_USERNAME/ras-pi
|
|
```
|
|
|
|
3. **Create a branch:** Create a new branch for your changes:
|
|
|
|
```bash
|
|
git checkout -b feature/your-feature-name
|
|
```
|
|
|
|
or
|
|
|
|
```bash
|
|
git checkout -b fix/your-bug-fix
|
|
```
|
|
|
|
4. **Make your changes:** Implement your changes. Please try to follow the project's general vibe with lots of comments and documentation, particularly for new features.
|
|
5. **Commit your changes:** Commit your changes with clear and concise commit messages:
|
|
|
|
```bash
|
|
git add .
|
|
git commit -m "Add your feature/fix description"
|
|
```
|
|
|
|
6. **Push your changes:** Push your branch to your forked repository:
|
|
|
|
```bash
|
|
git push origin feature/your-feature-name
|
|
```
|
|
|
|
7. **Create a pull request:** Go to SLCPL-CreativeLab/ras-pi repository on GitHub and click the "New Pull Request" button. Select your branch and provide a clear description of your changes.
|
|
|
|
## Guidelines
|
|
|
|
* **Coding Style:** Please adhere to the project's coding style. If there are no specific guidelines, follow common best practices.
|
|
* **Commit Messages:** Use clear and descriptive commit messages.
|
|
* **Documentation:** Update the documentation as needed to reflect your changes.
|
|
* **Issue Tracking:** If you're addressing an existing issue, please reference it in your pull request.
|
|
* **Respectful Communication:** Please be respectful and considerate of other contributors.
|
|
|
|
## Reporting Issues
|
|
|
|
If you find a bug or have a feature request, please open an issue on GitHub. Provide as much detail as possible, including steps to reproduce the issue.
|
|
|
|
## Getting Help
|
|
|
|
If you have any questions or need help, please open an issue or reach out to us through [email](mailto:jashton@slcpl.org).
|
|
|
|
Thank you for contributing to SLCPL-CreativeLab/ras-pi!
|