зеркало из https://github.com/microsoft/cobalt.git
Merge pull request #53 from Microsoft/erisch/features/contrib-guidelines
Adding Contributing Guidelines + PR Template
This commit is contained in:
Коммит
388478de6c
|
@ -0,0 +1,6 @@
|
|||
# Lines starting with '#' are comments.
|
||||
# Each line is a file pattern followed by one or more owners,
|
||||
# the last matching pattern has the most precendence.
|
||||
|
||||
# Core team members from cobalt
|
||||
* @erikschlegel
|
|
@ -0,0 +1,21 @@
|
|||
# Contributing
|
||||
|
||||
Some general guidance around the process and steps to follow when contributing to this repository.
|
||||
|
||||
Clone the repo, and create a new feature branch on your local machine. Please name your feature branches by [convention](https://docs.microsoft.com/en-us/azure/devops/repos/git/git-branching-guidance?view=vsts#name-your-feature-branches-by-convention)(i.e. `$USER/bugfix/description`, `$USER/features/feature-area/feature-name`).
|
||||
|
||||
Make sure the tests pass both locally and through the CI build pipeline.
|
||||
|
||||
Push your branch to `origin` and submit a new pull request.
|
||||
|
||||
You should expect code reviewers to comment on pull requests within one business day. We may suggest some changes or improvements or alternatives.
|
||||
|
||||
Following an approval, the pull request submitter is responsible for squashing their commit messages completing their pr and deleting the branch.
|
||||
|
||||
Some things that will increase the chance that your pull request is accepted:
|
||||
|
||||
* Review our code review [guidance](https://github.com/Microsoft/code-with-engineering-playbook/blob/master/Engineering/CodeReviews.md).
|
||||
* Follow our [engineering playbook](https://github.com/Microsoft/code-with-engineering-playbook#the-basics) and the [style guide][style] for this project.
|
||||
* Include [unit tests](https://github.com/Microsoft/code-with-engineering-playbook/blob/master/Engineering/UnitTesting.md) and [end-to-end integration tests](https://martinfowler.com/bliki/IntegrationTest.html).
|
||||
* Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
|
||||
* Pull request changes should meet the minimum code coverage threshold.
|
|
@ -0,0 +1,40 @@
|
|||
## All Submissions:
|
||||
-------------------------------------
|
||||
* [YES/NO] Have you followed the guidelines in our Contributing [document](./CONTRIBUTING.md)?
|
||||
* [YES/NO] Have you added an explanation of what your changes do and why you'd like us to include them?
|
||||
* [YES/NO] I have updated the documentation accordingly.
|
||||
* [YES/NO/NA] I have added tests to cover my changes.
|
||||
* [YES/NO/NA] All new and existing tests passed.
|
||||
* [YES/NO/NA] My code follows the code style of this project.
|
||||
* [YES/NO/NA] I ran lint checks locally prior to submission.
|
||||
* [YES/NO] Have you checked to ensure there aren't other open [Pull Requests](../../pulls) for the same update/change?
|
||||
|
||||
## What is the current behavior?
|
||||
-------------------------------------
|
||||
<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
|
||||
|
||||
Issue Number: N/A
|
||||
|
||||
|
||||
## What is the new behavior?
|
||||
-------------------------------------
|
||||
<!-- Please describe the behavior or changes that are being added by this PR. -->
|
||||
|
||||
-
|
||||
-
|
||||
-
|
||||
|
||||
## Does this introduce a breaking change?
|
||||
-------------------------------------
|
||||
- [YES/NO]
|
||||
|
||||
<!-- If this introduces a breaking change, please describe the impact and migration path for existing applications below. -->
|
||||
|
||||
## Any relevant logs, error output, etc?
|
||||
-------------------------------------
|
||||
(If it’s long, please paste to https://ghostbin.com/ and insert the link here.)
|
||||
|
||||
|
||||
## Other information
|
||||
-------------------------------------
|
||||
<!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. -->
|
Загрузка…
Ссылка в новой задаче