Skip to content

Latest commit

 

History

History
38 lines (23 loc) · 2.21 KB

CONTRIBUTING.md

File metadata and controls

38 lines (23 loc) · 2.21 KB

Contributing to Apillon

Thank you for considering contributing to Apillon! 🎉

The following is a set of contribution guidelines. Use your best judgment, and feel free to propose changes to this document in a pull request.

How Can I Contribute?

Reporting Bugs

Before creating a bug report, please check the existing issues to see whether the problem has already been reported. If it hasn't, open a new issue and provide a clear and detailed description of the problem, including steps to reproduce it. Please also make sure to read our bug bounty program

Suggesting Upgrades

If you have an idea of how to enhance Apillon, we'd love to hear it! Before submitting an improvement suggestion, please check the existing issues and pull requests. If it's a new idea and hasn't been suggested yet, open an issue and provide a clear description of what you propose.

Pull Requests

Anyone can initiate a pull request for Apillon! Before you start working on a pull request, please open an issue to discuss the changes you'd like to make. This ensures that your contribution aligns with the project's goals and allows others to provide feedback. After your pull request has been submitted, make sure you link it to the issue.

When submitting a pull request, please follow these guidelines:

  • Fork the repository and create a new branch for your feature or bug fix. The branch name needs to be prefixed with the proper context (e.g. feature/, fix/, etc.).
  • Make changes while ensuring your code follows the project's coding style and conventions.
  • Write tests to cover any new functionality or changes and ensure all tests pass.
  • Update the documentation if needed.
  • Commit your changes using clear and descriptive commit messages.
  • Push your branch to your fork and open a pull request against the main repository's main branch.

Resources

Contact

If you have any questions or need further assistance, feel free to contact us at [info@apillon.io].