Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 1.82 KB
Raw

How to contribute

Thank you for considering contributing to this project. We need developers like you to help improve and enhance the project.

If you have an issue, found a bug or have an idea to improve the project, open an issue.

Testing

To help maintain the highest quality code possible, we require all contributions to ensure unit tests, documentation and clean code and commented.. In short, this is an open source project, so do your due diligence to ensure full test and documentation.

Submitting changes

In order to change this project, we follow a “Fork and Pull” model. The fork and pull works like this:

  1. Create a personal fork of this repository.
  2. Create a working branch within your personal fork.
  3. Make changes to the project within your branch.
  4. Once complete. create a pull request from your fork with your proposed changes.
  5. If approved, it will be merged into main and a build will be created if needed.

Please always write clear message for your commits. One-line messages are ok for slight changes but large changes should contain:

$ git commit -m “A short summary of the commit
> 
> A paragraph describing what changed, how it was tested and its impact to the project.”

Contribution Standards

If you look at the project you will see we optimize for readability, maintainability, documentation and testing. Below are some general guidelines to follow:

  • Each change should be logical and have its own commit.
  • All changes must be tested and covered by tests.
  • Please leave comments where it makes sense.
  • If working with the project has changed functionality, please update the readme.
  • Document your pull requests. Be sure to document the reason for the change and the testing done.
  • Please follow existing code and documentation flow, style and practices.

Thanks, General Motors