Skip to content

Latest commit

 

History

History
48 lines (27 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

48 lines (27 loc) · 1.4 KB
Raw

Contributing to Allen Institute for Cell Science Open Source

Thank you for your interest in contributing to this Allen Institute for Cell Science open source project! This document is a set of guidelines to help you contribute to this project.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

Project Documentation

The README in the root of the repository should contain or link to project documentation. If you cannot find the documentation you're looking for, please file a GitHub issue with details of what you'd like to see documented.

How to Contribute

Typical steps to contribute:

  1. Fork the repo on GitHub.

  2. Create a branch and make your edits on your branch, pushing back to your fork.

  3. Ensure that your changes are working, pass any linting and tests in the project. Add tests and documentation as needed.

  4. Submit a pull request to merge your fork's branch into this repository, via GitHub.

Questions or Thoughts?

Talk to us on one of our community forums.

Releases

on main branch:

  1. update the version number in the "project()" in CMakeLists.txt

  2. cd agave_pyclient

  3. bump2version --current-version oldVersion --new-version newVersion --tag

  4. upon push, github actions will automatically build the release.