You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When your contribution is ready, you can create a pull request. Pull requests are often referred to as "PR". In general, we follow the standard [GitHub pull request](https://help.github.com/en/articles/about-pull-requests) process. Follow the template to provide details about your pull request to the maintainers. It's best to break your contribution into smaller PRs with incremental changes, and include a good description of the changes.
34
-
We require new unit tests to be contributed with any new functionality added.
33
+
When your contribution is ready, you can create a pull request. Pull requests are often referred to as "PR". In general, we follow the standard [GitHub pull request](https://help.github.com/en/articles/about-pull-requests) process. Follow the template to provide details about your pull request to the maintainers.
34
+
1. It's best to break your contribution into smaller PRs with incremental changes, and include a good description of the changes in the PR description.
35
+
2. We require new unit tests to be contributed with any new functionality added.
36
+
3. We require each feature to be documented as part of the PR. If certain feature is experimental and not documented it will be announced as a dev preview.
37
+
4. We require any new unit tests that are gated by conditions such as package availability must be executed, and details of those along with a screenshot of the test results should be included in the PR description.
35
38
36
39
Before sending pull requests, make sure your changes pass formatting, linting and unit tests. These checks will run with the pull request builds. Alternatively, you can run the checks manually on your local machine [as specified below](#development).
37
40
@@ -50,6 +53,8 @@ Once you've [created a pull request](#how-can-i-contribute), maintainers will re
50
53
- Follow the project coding conventions
51
54
- Write detailed commit messages
52
55
- Break large changes into a logical series of smaller patches, which are easy to understand individually and combine to solve a broader issue
56
+
- Ensure documentation is added on `how to use` any new capabilities.
57
+
- Ensure follow-up issues are created for documentation and that feature is not officially released without full documentation.
53
58
54
59
Maintainers will perform "squash and merge" actions on PRs in this repo, so it doesn't matter how many commits your PR has, as they will end up being a single commit after merging.
0 commit comments