Merge pull request #906 from PowerShell/andschwa/github-templates
Add GitHub templates
This commit is contained in:
commit
9afcada6ef
7 changed files with 57 additions and 22 deletions
31
CONTRIBUTING.md → .github/CONTRIBUTING.md
vendored
31
CONTRIBUTING.md → .github/CONTRIBUTING.md
vendored
|
@ -8,9 +8,6 @@ Rules
|
|||
|
||||
Don't forget to commit early and often!
|
||||
|
||||
Please add `[ci skip]` to commits that should be ignored by the CI systems
|
||||
(e.g. changes to documentation).
|
||||
|
||||
All pull requests **must** pass both CI systems before they will be approved.
|
||||
|
||||
Write *good* commit messages. Follow Tim Pope's [guidelines][]:
|
||||
|
@ -25,10 +22,10 @@ Write *good* commit messages. Follow Tim Pope's [guidelines][]:
|
|||
New to Git?
|
||||
-----------
|
||||
|
||||
- [Git Basics](docs/git/basics.md): install and getting started.
|
||||
- [Git for sd users](docs/git/source-depot.md): a handy reference
|
||||
- [Git Basics](../docs/git/basics.md): install and getting started.
|
||||
- [Git for sd users](../docs/git/source-depot.md): a handy reference
|
||||
document for people familiar with `sd`.
|
||||
- [Commit process](docs/git/committing.md): step-by-step commit guide
|
||||
- [Commit process](../docs/git/committing.md): step-by-step commit guide
|
||||
with all gory details.
|
||||
|
||||
Authentication
|
||||
|
@ -62,7 +59,7 @@ Particularly:
|
|||
[MS-OSS-Hub]: https://opensourcehub.microsoft.com/articles/how-to-join-microsoft-github-org-self-service
|
||||
[2 factor authentication]: https://github.com/blog/1614-two-factor-authentication
|
||||
|
||||
[Branches](docs/workflow/branches.md)
|
||||
[Branches](../docs/workflow/branches.md)
|
||||
-------------------------------------
|
||||
|
||||
* Checkout a new local branch for every change you want to make (bugfix, feature).
|
||||
|
@ -75,16 +72,15 @@ Particularly:
|
|||
Permissions
|
||||
-----------
|
||||
|
||||
If you have difficulty in pushing your changes, there is a high
|
||||
probability that you actually don't have permissions.
|
||||
If you have difficulty in pushing your changes, there is a high probability that
|
||||
you actually don't have permissions.
|
||||
|
||||
Be sure that you have write access to corresponding repo (remember
|
||||
that submodules have their own privilege).
|
||||
Be sure that you have write access to corresponding repo (remember that
|
||||
submodules have their own privilege).
|
||||
|
||||
You do *not* necessarily need to have write permissions to the main
|
||||
repositories, as you can also just [fork a repo][].
|
||||
|
||||
[fork a repo]: https://help.github.com/articles/fork-a-repo/
|
||||
Your should push to this repository instead of a fork so that the CI system can
|
||||
provide credentials to your pull request. If you make a pull request from a
|
||||
fork, the CI *will* fail.
|
||||
|
||||
Recommended Git configurations
|
||||
------------------------------
|
||||
|
@ -117,13 +113,12 @@ git config --global rerere.autoUpdate true
|
|||
git config --global am.threeWay true
|
||||
```
|
||||
|
||||
[Mapping](docs/workflow/mapping.md)
|
||||
[Mapping](../docs/workflow/mapping.md)
|
||||
-----------------------------------
|
||||
|
||||
Learn about new files locations in PowerShell/PowerShell.
|
||||
|
||||
[Resources](docs/workflow/resources.md)
|
||||
[Resources](../docs/workflow/resources.md)
|
||||
---------------------------------------
|
||||
|
||||
Learn how to work with string resources in `.resx` files.
|
||||
|
32
.github/ISSUE_TEMPLATE.md
vendored
Normal file
32
.github/ISSUE_TEMPLATE.md
vendored
Normal file
|
@ -0,0 +1,32 @@
|
|||
Before submitting this issue, please first:
|
||||
|
||||
- [ ] Search the existing issues.
|
||||
- [ ] Refer to the [FAQ](../docs/FAQ.md).
|
||||
- [ ] Refer to the [known issues](../docs/KNOWNISSUES.md).
|
||||
- [ ] If it is a bug, fill out this form:
|
||||
|
||||
Steps to reproduce
|
||||
------------------
|
||||
|
||||
|
||||
Expected behavior
|
||||
-----------------
|
||||
|
||||
|
||||
Actual behavior
|
||||
---------------
|
||||
|
||||
|
||||
Environment data
|
||||
----------------
|
||||
|
||||
Please fill in the results of the following commands:
|
||||
|
||||
```sh
|
||||
$ dotnet --info
|
||||
|
||||
|
||||
$ git status
|
||||
|
||||
|
||||
```
|
8
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
8
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
@ -0,0 +1,8 @@
|
|||
Before submitting this pull request, please first:
|
||||
|
||||
- [ ] State that it "Resolves #xyz".
|
||||
- [ ] Ensure your code is up-to-date with `master`.
|
||||
- [ ] Add tests that fail without your changes.
|
||||
- [ ] Update all relevant [documentation](../docs).
|
||||
- [ ] Assign the PR to the appropriate subsystem [maintainer](https://aka.ms/psowners).
|
||||
- [ ] Check that your commits follow our [contributing guidelines](CONTRIBUTING.md)
|
|
@ -62,7 +62,7 @@ Obtain the source code
|
|||
|
||||
Install [Git][], the version control system.
|
||||
|
||||
See the [Contributing Guidelines](CONTRIBUTING.md) for more Git
|
||||
See the [Contributing Guidelines](.github/CONTRIBUTING.md) for more Git
|
||||
information, such as our installation instructions, contributing
|
||||
rules, and Git best practices.
|
||||
|
||||
|
|
|
@ -15,7 +15,7 @@ Git Setup
|
|||
|
||||
Using Git requires it to be setup correctly; refer to the
|
||||
[README](../../README.md) and
|
||||
[Contributing Guidelines](../../CONTRIBUTING.md).
|
||||
[Contributing Guidelines](../../.github/CONTRIBUTING.md).
|
||||
|
||||
This guide assumes that you have recursively cloned the PowerShell
|
||||
repository and `cd`ed into it.
|
||||
|
|
|
@ -16,7 +16,7 @@ Git Setup
|
|||
|
||||
Using Git requires it to be setup correctly; refer to the
|
||||
[README](../../README.md) and
|
||||
[Contributing Guidelines](../../CONTRIBUTING.md).
|
||||
[Contributing Guidelines](../../.github/CONTRIBUTING.md).
|
||||
|
||||
This guide assumes that you have recursively cloned the PowerShell
|
||||
repository and `cd`ed into it.
|
||||
|
|
|
@ -28,4 +28,4 @@ When you adding or removing string, `.cs` file need to be changed.
|
|||
1. Run `Start-ResGen` function from `PowerShellGitHubDev.psm1`
|
||||
1. Make sure your code is building with newly generated resources (run `Start-PSBuild`).
|
||||
1. Go to submodule (`cd src\windows-build`) and perform the [submodule commit dance](../git/committing.md).
|
||||
Follow working with [submodule rules](../../CONTRIBUTING.md#submodules)
|
||||
Follow working with [submodule rules](../../.github/CONTRIBUTING.md#submodules)
|
||||
|
|
Loading…
Reference in a new issue