Skip to content

Latest commit

 

History

History
122 lines (93 loc) · 5.68 KB

CONTRIBUTING.md

File metadata and controls

122 lines (93 loc) · 5.68 KB

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
  4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

  • The use of sexualized language or imagery and unwelcome sexual attention or advances
  • Trolling, insulting/derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others' private information, such as a physical or electronic address, without explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

Creating a new release

Here we document the steps taken when creating a new release

Release manager roles

  • Load MRs to create a flow for releases
  • Prompt developers to fix up issues and respond to comments
  • Create the release PR
  • Merge in PRs as they get approved
  • Merge the release MRs and create a tag (see below)
  • Present updates on the development call about MRs and your planned release cycle

Preparation

  1. Label all PRs which are part of the release using a relevantly named milestone.
  2. Make sure all the PRs for the release are merged and the CI is passing.
  3. Create a PR with updates in the CHANGELOG. Commit the changes with a message "Version X.Y.Z release" and merge to main.

Automated release

Once the PR is merged into main, create a release with a tag on the release page. The tag should follow versioning convention specified here. This will create a CI job which pushes the release to pypi using the credentials stored online.

Manual release (not recommended)

  1. Tag the current version $ git tag -a v1.4 -m "my version 1.4"
  2. Push tag to the main repository (not your fork) $ git push origin --tags
  3. Verify that $ python setup.py --version is a valid version (something like v0.0.0)
  4. Run $ python setup.py sdist - this will create a file dist/PACKAGENAME-VERSION.tar.gz
  5. Run $ twine upload dist/PACKAGENAME-VERSION.tar.gz (username is JazzHandsDev)

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4