Skip to content

Latest commit

 

History

History
94 lines (66 loc) · 2.7 KB

CONTRIBUTING.rst

File metadata and controls

94 lines (66 loc) · 2.7 KB
Raw

Contributing

Contributions and issues are most welcome! All issues and pull requests are handled through github on the dls_controls repository. Also, please check for any existing issues before filing a new one. If you have a great idea but it involves big changes, please file a ticket before making a pull request! We want to make sure you don't spend your time coding something that might not fit the scope of the project.

Running the tests

To get the source source code and run the unit tests, run:

$ git clone git://github.com/DiamondLightSource/pythonSoftIoc.git
$ cd pythonSoftIoc
$ git submodule init
$ git submodule update
$ pipenv install --dev
$ pipenv run tests

While 100% code coverage does not make a library bug-free, it significantly reduces the number of easily caught bugs! Please make sure coverage remains the same or is improved by a pull request!

Updating Dependencies

pythonSoftIoc has a variety of types of dependencies, from Python module to C files and built libraries. If it is necessary to update any of them, the safest way to do that is:

$ Ensure all changes are committed/saved/backed up
$ pipenv run gitclean
$ pipenv --rm
$ rm Pipfile.lock
$ Update dependencies in setup.cfg / pyproject.toml
$ pipenv install --dev

Code Styling

The code in this repository conforms to standards set by the following tools:

These tests will be run on code when running pipenv run tests and also automatically at check in. Please read the tool documentation for details on how to fix the errors it reports.

Documentation

Documentation is contained in the docs directory and extracted from docstrings of the API.

Docs follow the underlining convention:

Headling 1 (page title)
=======================

Heading 2
---------

Heading 3
~~~~~~~~~

You can build the docs from the project directory by running:

$ pipenv run docs
$ firefox build/html/index.html

Release Process

To make a new release, please follow this checklist:

  • Choose a new PEP440 compliant release number
  • Add a release note in CHANGELOG.rst
  • Git tag the version
  • Push to github and the actions will make a release on pypi
  • Push to internal gitlab but do not release from there
  • Run dls-py3 download-one-dependency softioc <release>
  • Run cp Pipfile.lock /dls_sw/work/python3/RHEL7-x86_64/distributions/softioc-<release>.Pipfile.lock
  • Run dls-release.py -a python3ext softioc <release>