Contributing to PyBlade

Thank you for considering contributing to PyBlade! We welcome contributions from everyone and appreciate your efforts in helping improve the project. Whether you're fixing bugs, adding new features, or improving documentation, your contributions are vital to the success of PyBlade.

How to Contribute

Reporting Issues

If you encounter a bug or have a feature request, please open an issue in the GitHub Issues section. Be sure to provide a clear description of the problem or the feature you’d like to see, along with any relevant details that may help us understand the issue.

Pull Requests

1. Fork the Repository: Create your own fork of the repository on GitHub.

2. Clone the Repository: Clone your fork to your local machine:

   git clone https://github.com/antaresmugisho/pyblade.git

3. Create a Branch: Create a new branch for your feature or bug fix:

   git checkout -b feature/my-feature

4. Make Your Changes: Implement your changes, ensuring to follow the project's coding standards and best practices.

5. Write Tests: If applicable, write tests to cover your changes.

6. Update Documentation: Ensure that any relevant documentation is updated to reflect your changes.

7. Commit Your Changes: Commit your changes with a descriptive message:

   git commit -m "Add my new feature"

8. Push to Your Fork: Push your changes back to your fork:

   git push origin feature/my-feature

9. Open a Pull Request: Navigate to the original repository and open a pull request from your feature branch. Provide a clear description of your changes and why they should be merged.

Code of Conduct

Please note that this project adheres to a Code of Conduct. By participating, you are expected to uphold this code in all interactions.

Getting Help

If you have questions or need assistance, feel free to ask in the GitHub Discussions or reach out directly to the project maintainers.

Thank You!

We appreciate your interest in contributing to PyBlade and look forward to your involvement!