-
Install the local dev packages using :
pip install -r dev_requirements.txt
-
Check for linting by calling at the root of the repo:
flake8
-
If there are any linting errors, try:
autopep8 --in-place --aggressive --aggressive --recursive ./
-
If that does not fixes the errors, fix the styling manually.
-
Run tests using :
pytest
-
Run local test files for LIMS testing
All branches should be named clearly and succinctly. The name should reflect the purpose of the work being done on the branch. Try to keep changes to be as close to solely reflecting the name of the branch.
Here are the naming conventions we follow:
- Feature branches: feature-short_feature_description
- Bugfix branches: feature-short_bug_fix_description
Branches should be kept as short-lived as possible. This means you should merge branches into the main or master branch as soon as the work is complete, tested, and reviewed.
After a branch has been merged, it should be deleted to keep the repository tidy.
When you're ready to merge your branch, open a pull request. All code should go through a pull request review process before being merged into the main branch.
Pull requests should be reviewed by at least one other developer uness a hot fix is needed. This ensures that we maintain a high standard of code quality and that more than one person understands each part of our codebase.
To avoid complex merge conflicts, regularly merge the main branch into your feature branches. This ensures that you're working with the most recent version of our codebase.
The main branch is protected. This means you cannot push to it directly. All changes must go through a pull request. We may add password protection in the future