Skip to content

Latest commit

 

History

History
31 lines (18 loc) · 2.73 KB

CONTRIBUTING.md

File metadata and controls

31 lines (18 loc) · 2.73 KB
Raw

How to contribute

First, thanks for taking the time to contribute to our project! There are many ways you can help out.

Questions

If you have a question that needs an answer, create an issue, and label it as a question. For general guidance on creating an issue, see github's article on creating an isue.

Issues for bugs or feature requests

If you encounter any bugs in the code, or want to request a new feature or enhancement, please create an issue to report it. Kindly add a label to indicate what type of issue it is. For general guidance about creating issues, read github's article on creating an issue.

Contribute Code

We welcome your pull requests for bug fixes. To implement something new, please create an issue first so we can discuss it together.

Creating a Pull Request Please follow best practices for creating git commits.

When your code is ready to be submitted, read github's article about how to submit a pull request to begin the code review process and follow its directions. Before creaing a pull request, please do the following to make sure the patch is ready for review:

  1. Run the tools/format.sh script to format the source code according to the repository's formatting standards.
  2. Verify that all AuTests pass (see the README for instructions on how to run the AuTests).
  3. Verify that all unit tests pass (see the README for instructions on how to run the unit tests).

We only seek to accept code that you are authorized to contribute to the project. We have added a pull request template on our projects so that your contributions are made with the following confirmation:

I confirm that this contribution is made under the terms of the license found in the root directory of this repository's source tree and that I have the authority necessary to make this contribution on behalf of its copyright owner.

Code of Conduct

We encourage inclusive and professional interactions on our project. We welcome everyone to open an issue, improve the documentation, report bug or ssubmit a pull request. By participating in this project, you agree to abide by the Verizon Media Code of Conduct. If you feel there is a conduct issue related to this project, please raise it per the Code of Conduct process and we will address it.