Contributing to iDempiere

First off, thanks for taking the time to contribute!

If you arrive to this page is because you want to contribute to the project and we would like to make that task as easy as possible to you. We need volunteer developers to help this project come to fruition.

If you haven't already, come find us in Mattermost. We want you working on things you're excited about.

The following is a set of guidelines for contributing to iDempiere. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Before starting, make sure that you read our code of conduct. This project and everyone participating in it is governed by the iDempiere's Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behaviour.

How Can I Contribute?

Did you find a bug?

• Check the Bug Reporting Guidelines

Would you like to suggest a new feature or enhancement?

• Check the New Feature Suggestion Guidelines

There are many people in the community, some of them might have had a similar idea like yours, check the Let's join efforts page to collaborate with community members on developing nice features.

Do you want to contribute code by fixing a bug or adding an enhancement?

iDempiere uses a forking workflow for code contributions. To have a detailed explanation of how to create a pull request, please read the Fork and Branch Git Workflow page.

In summary, here are the steps to follow:

1. Create your personal fork.
2. Clone your fork to your local machine.
3. Synchronize your local repository with the upstream source.
4. Create a feature branch for your work.
5. Integrate your changes into the source code.
6. Test thoughtfully
7. Create a commit using the iDempiere standard message format: IDEMPIERE-[####] [Ticket Description].
8. Push your commit to your own fork.
9. Navigate to GitHub in the web browser.
10. Create a Pull request.

Do you want to review a pull request done by another community member?

• Read our Pull Request Review page and go for it.

Did you write a plugin that is valuable for the community?

• Read our Plugin Guidelines.
• Add your plugin to the Available Plugins.

Note: If the community or its leaders find that your plugin does not follow the guidelines, it's disrupting or needs further support from a specific implementing company to use it. The project leaders are entitled to remove the plugin from the Available plugins list.

Do you have questions about the source code?

• Ask any question about how to use iDempiere in the public forum or in the Mattermost support channel.

Do you want to contribute to the iDempiere documentation?

• Please read Contributing to iDempiere Documentation.
• Or if you like to do video tutorials please check Video Tutorials Guidelines.

Do you have an iDempiere distro and would like to promote it?'

• Please read IDempiere Distribution Guidelines.

Do you want to contribute a testimonial or a case study?

• Please read the Testimonials Guidelines

iDempiere is a community-driven open source project and it is a volunteer effort. We encourage you to pitch in and join the team!

Thanks!