Contribute

Minisat is an open source project that’s licensed under the GNU General Public License version 3. All contributions gladly accepted as long as they follow our programming guidelines.

Setting up the development

To create a development environment follow steps given for Minisat installation.

Setting up test environment

Pytest is used for testing and Travis-ci for Continuous Integration. Pull requests are tested against testcases by Travis-ci. If your pull request didn’t pass our test cases, you can visit the test job that failed and view its console output.

It is possible for you to run these same tests locally. To setup a testing environment, you need to download Selenium webdriver for Mozilla Firefox at mozilla geckodriver.

Extract the driver.

Export path

# export PATH=$PATH/:/path/of/driver

It will set a path variable to the webdriver.

And run the test

# pytest

To check whether your programming style matches our, use flake8

# flake8 --ignore=E501,E122,E722 minisat satellite

Submit Patches

Patches to fix bugs are always appreciated. Before introducing a new feature, create an issue first. If you are going to work on a specific issue, make a note in the issue section so that everyone knows what you’re working on. Please try to create an issue which is specific for your patch details. - Fork the project and Clone it

On GitHub, navigate to the Minisat repository. In the top-right corner of the page, click Fork.

To clone repo

# git clone https://github.com/<your-user-name>/minisat.git
  • Create a feature/topic branch
# git checkout -b <branchName>
  • Make the changes required and commit the code
# git add <modifiedFile(s)>
# git commit -m "Fixes #<bug> - <message>"
  • Push topic branch to your fork
# git push origin <branchName>
  • Create a pull request from <branchName> to testing branch.

To create pull request follow the link.