Skip to content

Latest commit

 

History

History
69 lines (47 loc) · 3.4 KB

CONTRIBUTING.md

File metadata and controls

69 lines (47 loc) · 3.4 KB

Contributing to BioModels-QC

We enthusiastically welcome contributions to BioModels-QC!

Coordinating contributions

Before getting started, please contact the lead developers at [email protected] to coordinate your planned contributions with other ongoing efforts. Please also use GitHub issues to announce your plans to the community so that other developers can provide input into your plans and coordinate their own work. As the development community grows, we will institute additional infrastructure as needed such as a leadership committee and regular online meetings.

Repository organization

This repository follows standard Python conventions:

  • README.md: Overview of this repository
  • biomodels_qc/: Source code for this package
  • tests/: Unit tests for this package
  • setup.py: pip installation script for this package
  • setup.cfg: Configuration for the pip installation script
  • requirements.txt: Dependencies of this package
  • MANIFEST.in: List of files to include when BioModels-QC is bundled into a Python package for installation with pip
  • LICENSE: License for this package
  • CONTRIBUTING.md: Guide to contributing to this package (this document)
  • CODE_OF_CONDUCT.md: Code of conduct for developers of this package

Coding convention

This repository follows standard Python style conventions:

  • Class names: UpperCamelCase
  • Function names: lower_snake_case
  • Variable names: lower_snake_case

Documentation convention

BioModels-QC is documented using reStructuredText and the napoleon Sphinx plugin. The documentation can be compiled with Sphinx by running the following commands:

python -m pip install -r docs-src/requirements.txt
sphinx-apidoc . setup.py --output-dir docs-src/source --force --module-first --no-toc
sphinx-build docs-src docs

Submitting changes

Please use GitHub pull requests to submit changes. Each request should include a brief description of the new and/or modified features.

Releasing new versions

To release changes, contact the lead developers to request their release.

Below are instructions for releasing a new version:

  1. Commit the changes to this repository.
  2. Increment the __version__ variable in biomodels_qc/_version.py.
  3. Commit this change to biomodels_qc/_version.py.
  4. Add a tag for the new version by running git tag { version }. version should be equal to the value of the __version__ variable in biomodels_qc/_version.py.
  5. Push these commits and the new tag to GitHub by running git push && git push --tags.
  6. This push will trigger a GitHub action which will execute the following tasks:
    • Create a GitHub release for the version.
    • Push the release to PyPI.
    • Compile the documentation and push the compiled documentation to the repository so that the new documentation is viewable at github.io.

Reporting issues

Please use GitHub issues to report any issues to the development community.

Getting help

Please use GitHub issues to post questions or contact the lead developers at [email protected].