Skip to content

Latest commit

 

History

History
78 lines (45 loc) · 3.93 KB

CONTRIBUTING.md

File metadata and controls

78 lines (45 loc) · 3.93 KB
Raw

Contributing to {{ project }}

NOTE: This is a template document that requires editing before it is ready to use!

We welcome contributions from the community and first want to thank you for taking the time to contribute!

Please familiarize yourself with the Code of Conduct before contributing.

TO BE EDITED: Depending on the open source license that governs the project, leave only one of the options below:

  • DCO: Before you start working with {{ project }}, please read our Developer Certificate of Origin. All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch.
  • CLA: Before you start working with {{ project }}, please read and sign our Contributor License Agreement CLA. If you wish to contribute code and you have not signed our contributor license agreement (CLA), our bot will update the issue when you open a Pull Request. For any questions about the CLA process, please refer to our FAQ.

Ways to contribute

We welcome many different types of contributions and not all of them need a Pull request. Contributions may include:

  • New features and proposals
  • Documentation
  • Bug fixes
  • Issue Triage
  • Answering questions and giving feedback
  • Helping to onboard new contributors
  • Other related activities

Getting started

TO BE EDITED: This section explains how to build the project from source, including Development Environment Setup, Build, Run and Test.

Provide information about how someone can find your project, get set up, build the code, test it, and submit a pull request successfully without having to ask any questions. Also include common errors people run into, or useful scripts they should run.

List any tests that the contributor should run / or testing processes to follow before submitting. Describe any automated and manual checks performed by reviewers.

Contribution Flow

This is a rough outline of what a contributor's workflow looks like:

  • Make a fork of the repository within your GitHub account
  • Create a topic branch in your fork from where you want to base your work
  • Make commits of logical units
  • Make sure your commit messages are with the proper format, quality and descriptiveness (see below)
  • Push your changes to the topic branch in your fork
  • Create a pull request containing that commit

We follow the GitHub workflow and you can find more details on the GitHub flow documentation.

Before submitting your pull request, we advise you to use the following:

Pull Request Checklist

  1. Check if your code changes will pass both code linting checks and unit tests.
  2. Ensure your commit messages are descriptive. We follow the conventions on How to Write a Git Commit Message. Be sure to include any related GitHub issue references in the commit message. See GFM syntax for referencing issues and commits.
  3. Check the commits and commits messages and ensure they are free from typos.

Reporting Bugs and Creating Issues

For specifics on what to include in your report, please follow the guidelines in the issue and pull request templates when available.

TO BE EDITED: Add additional information if needed.

Ask for Help

TO BE EDITED: Provide information about the channels you use to communicate (i.e. Slack, IRC, Discord, etc)

The best way to reach us with a question when contributing is to ask on:

  • The original GitHub issue
  • The developer mailing list
  • Our Slack channel

Additional Resources

Optional