First, thanks for taking the time to contribute to our project! Anyone is welcome to learn about Oak and contribute to it. The following information provides a guide for making contributions.
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.
If you simply have a question that needs an answer, create an issue, and label it as a question.
If you encounter any bugs while using this software, or want to request a new feature or enhancement, feel free to create an issue to report it, make sure you add a label to indicate what type of issue it is.
Pull requests are welcome for bug fixes. If you want to implement something new, please request a feature 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, submit a pull request to begin the code review process.
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.
Please follow best practices for creating git commits.
We also ask you to use the following guidelines:
- Make sure your code respects existing formatting conventions. In general, follow the same coding style as the code that you are modifying.
- Do add/update documentation appropriately for the change you are making.
- Bugfixes should include a unit test or integration test reproducing the issue.
- Do not use author tags/information in the code.
- Always include license header on each file your create.
- Try to keep pull requests short and submit separate ones for unrelated features, but feel free to combine simple bugfixes/tests into one pull request.
- Keep the number of commits small and combine commits for related changes. Each commit should compile on its own and ideally pass tests.
- Keep formatting changes in separate commits to make code reviews easier and distinguish them from actual code changes.
When your code is ready to be submitted, you can submit a pull request to begin the code review process.