Skip to content

Commit 5b2d3d2

Browse files
author
Anthony Sneed
committed
Update PR template, ReadMe, Contributing files.
1 parent 25d3962 commit 5b2d3d2

File tree

3 files changed

+21
-1
lines changed

3 files changed

+21
-1
lines changed

.github/CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ _Contributions from the community are welcome!_
66

77
## Pull Request Process
88

9+
> For an overview of the pull request process, watch this [online tutorial](https://youtu.be/gxhbH9fzTDo).
10+
11+
### Fork, Branch, Test
12+
913
1. Before creating a pull request, first create an [issue](https://guides.github.com/features/issues/) to discuss the contribution you would like to make.
1014
2. [Fork](https://guides.github.com/activities/forking/) this repository.
1115
3. [Clone](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) your **fork** (not the original repository).
@@ -42,6 +46,9 @@ _Contributions from the community are welcome!_
4246
```
4347
10. Re-run the EF Core scaffolding command.
4448
- Ensure that context and model classes are generated as expected.
49+
50+
### Stage, Commit, Push
51+
4552
11. [Stage](https://www.atlassian.com/git/tutorials/saving-changes) and [commit](https://www.atlassian.com/git/tutorials/saving-changes/git-commit) your changes.
4653
- Add as many commits as you like. (Later you will squash these into a single commit.)
4754
```
@@ -52,6 +59,9 @@ _Contributions from the community are welcome!_
5259
```
5360
git push -u origin @fix/my-bug-fix
5461
```
62+
63+
### Create Pull Request
64+
5565
13. Create a [pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests).
5666
- Include a general description of your proposed changes.
5767
- Put `Closes #XXXX` in your comment. This will auto-close the issue that your PR fixes.
@@ -80,6 +90,9 @@ _Contributions from the community are welcome!_
8090
```
8191
git push --force
8292
```
93+
94+
### Squash Commits
95+
8396
16. After the reviewer accepts your PR, [squash](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html) your commits into a single commit.
8497
- If you like install [Visual Studio Code](https://code.visualstudio.com/) and make it your default Git editor.
8598
```

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,7 @@
22
Write a general description of what you would like to fix or improve.
33

44
**Put `Closes #XXXX` in your comment**
5-
This will auto-close the issue that your PR fixes.
5+
This will auto-close the issue that your PR fixes.
6+
7+
**Additional Resources**
8+
Refer to the [Contributing Guidelines](https://github.com/TrackableEntities/EntityFrameworkCore.Scaffolding.Handlebars/blob/master/.github/CONTRIBUTING.md) for this project.

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ Scaffold EF Core models using Handlebars templates.
44

55
- Uses [Handlebars.NET](https://github.com/rexm/Handlebars.Net) to compile [Handlebars](http://handlebarsjs.com) templates when generating models with the [Entity Framework Core](https://github.com/aspnet/EntityFrameworkCore) scaffolding tools.
66

7+
## Contributing
8+
9+
Before creating a pull request, please refer to the [Contributing Guidelines](https://github.com/TrackableEntities/EntityFrameworkCore.Scaffolding.Handlebars/blob/master/.github/CONTRIBUTING.md).
10+
711
## Prerequisites
812

913
- [Visual Studio 2019](https://www.visualstudio.com/downloads/) 16.4 or greater.

0 commit comments

Comments
 (0)