Skip to content

Latest commit

 

History

History
37 lines (20 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

37 lines (20 loc) · 1.27 KB
Raw

Contributing Guidelines

How to Submit Changes

  • Internal (Core-team) Contributions
  • External Contributions (Fork workflow)
  • Pull Requests

Branching/Release Strategy

Describe the release and branching strategy of this repository. Github flow? Gitflow? Trunk-based development, etc..

How to Create a Release

Describe how and when to create a release. This will depend on the build pipeline and branching strategy for the project.

Commits

Describe the format of acceptable commits for this project (here is a good example). How many commits per PR, etc?

Adding Dependencies

Describe how to add dependencies to your project (e.g adding to requirements.[yaml,txt]) and how dependencies should be vetted.

Coding Conventions

If a coding style is enforced, describe it here with links to the coding style guide and how to run the style checker if one is employed.

Testing

Writing Tests

Describe the location of the tests in the repository and the types of tests that exist. Provide information and links to the testing libraries used.

Running Tests

Give step-by-step instructions on how to run the tests (locally and/or in a staging environment) and how to determine if they were successful.