Skip to content
This repository has been archived by the owner on Mar 9, 2024. It is now read-only.

Latest commit

History

History
46 lines (27 loc) 路 2.16 KB

CONTRIBUTING.md

File metadata and controls

46 lines (27 loc) 路 2.16 KB

Contributing to Timelapse

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.

Ways of Contributing

Reporting an Issue

Make sure you test against the latest released version. It is possible that we may have already fixed the bug you're experiencing.

Provide steps to reproduce the issue, including operating system version and software version.

Working on an issue

Please make sure there is an issue associated with the work that you're doing.

If you're working on an issue, please comment that you are doing so to prevent duplicate work by others also.

Squash your commits and refer to the issue using fix # or close # in the commit message, at the end. For example: resolve answers to everything (fix #42) or resolve answers to everything, fix #42

Rebase master with your branch before submitting a pull request.

Commit Messages

The first line should be a summary of the changes, not exceeding 50 characters, followed by an optional body which has more details about the changes. Refer to this link for more information on writing good commit messages.

Use the imperative present tense: "add/fix/change", not "added/fixed/changed" nor "adds/fixes/changes".

Don't capitalize the first letter of the summary line.

Don't add a period/dot (.) at the end of the summary line.

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 and useful file locations.
  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 another developer, or if you do not have permission to do that, you may request the reviewer to merge it for you.