Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (41 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

55 lines (41 loc) · 1.78 KB

🤝 Contributing to BrewWare

Thank you for your interest in contributing to BrewWare! We welcome contributions of all kinds, including bug fixes, feature additions, documentation improvements, and more. This guide will help you get started.

📋 How to Contribute

1. Fork the Repository

Click the Fork button at the top right of the repository page to create your copy of the project.

2. Clone Your Fork

git clone https://github.com/your-username/repository-name.git
cd repository-name

3. Create a Branch

Use a descriptive name for your branch:

git checkout -b feature/your-feature-name

4. Make Changes

Implement your feature, fix the bug, or improve the documentation. Ensure your code follows our style guidelines and includes relevant tests.

5. Commit Your Changes

Write clear, concise commit messages:

git add .
git commit -m "Add feature: brief description of your changes"

6. Push to Your Fork

git push origin feature/your-feature-name

7. Open a Pull Request

Go to the original repository on GitHub and click New Pull Request. Provide a detailed description of your changes and link to any relevant issues.

🔍 Code of Conduct

By participating, you agree to abide by our Code of Conduct, fostering a welcoming and respectful environment for all contributors.

✅ Contribution Guidelines

  • Keep pull requests focused on a single issue or feature.
  • Write clear, descriptive commit messages.
  • Update documentation and tests as needed.
  • Ensure code passes all tests and checks.

📞 Need Help?

If you have questions or need assistance:

  • Open an issue on GitHub.
  • Reach out on our Discord.

Thank you for contributing to BrewWare! 🚀