Contributing

Thank you for considering to contribute to Elarian.

This document provides you with everything you need to get started. We encourage all sorts of contributions including (but not limited to):

Writing tutorials or blog posts
Improving the documentation
Submitting new features
Submitting bug reports and fixes

Assumptions

You're familiar with GitHub PR workflow
You've read the Elarian documentation
Your change has an issue. Find an existing issue or open a new issue.
You've discussed the with Elarian community

How to Contribute

Fork the Elarian repository in your own GitHub account.
Create a new Git branch
Make your changes on your branch.
- Make sure tests are updated accordingly
Submit the branch as a PR pointing to the master branch of the Elarian repository.
- A maintainer should comment and/or review your PR within a few hours or days.

Git Guidelines

We recommend commit messages follow the Chris Beams style.
The PR title should be accurate and descriptive of the changes.
Draft PRs are recommended when you want to show that you are working on something and make your work visible.
- Convert your PR to a draft if your changes are a work in progress.
- Maintainers will review the PR once you mark it as ready for review.
The branch related to the PR must be up-to-date with master before merging.