Contributing to Assemblerflow

Thank you for your interest in contributing to Assemblerflow. All kinds of contributions are welcome 🎉!

Issues

Feel free to submit issues and enhancement requests.

Contributions with new code (not documentation), should follow this standard procedure:

<new_branch> >> dev >> master

Create a new branch for the new feature/bug fix.
One the new code is finished and passes all automated tests, it will be merged into the dev branch. This branch is where all the new code lives and serves as an incubator stage while field tests are performed to ensure that everything is working correctly.
Merging the dev code into master is associated with a new release. Therefore, the master branch is basically the same of the latest official release in PyPI.

In general, we follow the "fork-and-pull" Git workflow.

Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull request so that we can review your changes. Pull requests will be merged first into the dev branch to perform some field tests before being merged into master

NOTE: Be sure to merge the latest from "upstream" before making a pull request!