Contributions are always welcome from the community. If you are interested in contributing but intimidated or unsure how to get setup, please contact one of the project maintainers for help and encouragement.
Questions and Bugs can be submitted on the GitHub issues page. Before creating a new issue, please take a moment to search open and closed issues and make sure a similar issue does not already exist. If one does exist, you can comment on the existing issue to show your support for that issue.
All code is compatible with 3.4+. We use PEP8 conventions for all Python code, and recommend running a code checker prior to submitting a pull request. Black is the recommended code formatter.
For docstrings we're using the numpy format We use pytest for all testing and will require tests for new features.
Prior to contributing you will need to create a GitHub fork of the project that you will be pushing your changes to.
Create a new branch in your fork with a name that describes the feature or bug you'll be addressing.
Create a GitHub pull request early in the process so that the project maintainers will be aware of your effort and able to coordinate your changes with current development.
We use the Anaconda distribution system for installation of the development environment, and recommend setting up a specific environment for this development effort.
Use the file fort-pymdwizard/mdwizard_dev_env.yaml to install requirements in new dev environments.
cd into pymdwizard folder you're developing in py.test
cd into pymdwizard folder you're developing in sphinx-build -b html docs docs/html_output