Skip to content

Latest commit

 

History

History
86 lines (50 loc) · 4.91 KB

CONTRIBUTING.md

File metadata and controls

86 lines (50 loc) · 4.91 KB
Raw

How to contribute to Amiberry

We'd be really happy to get more people involved in the project! If you want to help, please follow these guidelines.

If you haven't already, come find us in one of these platforms:

If you found a bug

Bug reporting is an important part of making Amiberry better. If you believe you have found a bug, then please follow these steps:

  • Ensure the bug has not already been reported. Check the existing Github Issues.

  • If you're unable to find an open issue that addresses the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible and steps to recreate the problem.

  • Please use the relevant bug report template to create the issue. It was designed to help you fill in what we need, in order to locate the source of the problem and find a solution in the best way possible.

Did you write a patch that fixes a bug?

  • Open a new Github Pull Request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

  • Please use the relevant pull request template when submitting a PR.

  • Please ensure that all your commits are atomic (one feature per commit).

Do you have a request for a new feature?

  • New feature ideas are welcome, but please keep in mind they will usually take lower priority over fixing bugs. An exception to that rule might be that it's something quite easy to implement.

Do you intend to add a new feature or change an existing one?

  • Suggest your change in one of the Amiberry pages above and start writing your code.

  • Please do not open an issue on Github until you have collected positive feedback about the change. Someone else might already be working on something similar, or perhaps this change could create a problem you haven't predicted.

Did you write something that adds new features/functionality to Amiberry?

  • Open a new Github Pull Request with your changes.

  • Ensure the PR description clearly describes what your changes are designed to improve. Include the relevant issue number if applicable.

  • Please use the relevant pull request template when submitting a PR.

  • Please ensure that all your commits are atomic (one feature per commit).

Financial contributions

We also welcome financial contributions in full transparency on our open collective. Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.

Credits

Contributors

Thank you to all the people who have already contributed to Amiberry!

Backers

Thank you to all our backers! [Become a backer]

Sponsors

Thank you to all our sponsors! (please ask your company to also support this open source project by becoming a sponsor)