mirror of
https://github.com/infinition/Bjorn.git
synced 2025-12-06 06:11:46 +00:00
52 lines
1.8 KiB
Markdown
52 lines
1.8 KiB
Markdown
# 🤝 Contributing to Bjorn
|
||
|
||
We welcome contributions to Bjorn! To make sure the process goes smoothly, please follow these guidelines:
|
||
|
||
## 📋 Code of Conduct
|
||
|
||
Please note that all participants in our project are expected to follow our [Code of Conduct](#-code-of-conduct). Make sure to review it before contributing.
|
||
|
||
## 🛠 How to Contribute
|
||
|
||
1. **Fork the repository**:
|
||
Fork the project to your GitHub account using the GitHub interface.
|
||
|
||
2. **Create a new branch**:
|
||
Use a descriptive branch name for your feature or bugfix:
|
||
|
||
git checkout -b feature/your-feature-name
|
||
|
||
3. **Make your changes**:
|
||
Implement your feature or fix the bug in your branch. Make sure to include tests where applicable and follow coding standards.
|
||
|
||
4. **Test your changes**:
|
||
Run the test suite to ensure your changes don’t break any functionality:
|
||
|
||
- ...
|
||
5. **Commit your changes**:
|
||
Use meaningful commit messages that explain what you have done:
|
||
|
||
git commit -m "Add feature/fix: Description of changes"
|
||
|
||
6. **Push your changes**:
|
||
Push your changes to your fork:
|
||
|
||
git push origin feature/your-feature-name
|
||
|
||
7. **Submit a Pull Request**:
|
||
Create a pull request on the main repository, detailing the changes you’ve made. Link any issues your changes resolve and provide context.
|
||
|
||
## 📑 Guidelines for Contributions
|
||
|
||
- **Lint your code** before submitting a pull request. We use [ESLint](https://eslint.org/) for frontend and [pylint](https://www.pylint.org/) for backend linting.
|
||
- Ensure **test coverage** for your code. Uncovered code may delay the approval process.
|
||
- Write clear, concise **commit messages**.
|
||
|
||
Thank you for helping improve!
|
||
|
||
---
|
||
|
||
## 📜 License
|
||
|
||
2024 - Bjorn is distributed under the MIT License. For more details, please refer to the [LICENSE](LICENSE) file included in this repository.
|