Skip to content

Commit 0b0e4e9

Browse files
rileytaylorjoshsmith
authored andcommitted
added templates, moved CONTRIBUTING, updated README links
1 parent f7f764f commit 0b0e4e9

File tree

4 files changed

+24
-2
lines changed

4 files changed

+24
-2
lines changed
File renamed without changes.

.github/ISSUE_TEMPLATE.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Problem
2+
3+
Detail the problem here, including any possible solutions.
4+
5+
## Subtasks
6+
- [ ]
7+
- [ ]
8+
- [ ]
9+
10+
## References
11+
12+
Progress on: #

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# What's in this PR?
2+
3+
List the changes you made and your reasons for them.
4+
5+
Make sure any changes to code include changes to documentation.
6+
7+
## References
8+
Fixes #
9+
10+
Progress on: #

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Our goals:
1919

2020
We'd love to have you contribute to Code Corps directly!
2121

22-
- First, read the guidelines in our [`CONTRIBUTING.md`](CONTRIBUTING.md).
22+
- First, read the guidelines in our [`CONTRIBUTING.md`](.github/CONTRIBUTING.md).
2323
- Then check out some GitHub issues to see where you can help out.
2424

2525
You can also always come :wave: hello [in our Slack](http://slack.codecorps.org), where there are always a ton of us around to help you learn, debug, or just shoot the breeze.
@@ -51,7 +51,7 @@ We have several types of docs:
5151
- [API documentation](http://docs.codecorpsapi.apiary.io/) written in [API Blueprint](https://apiblueprint.org/) format in [`blueprint/api.apib`](blueprint/api.apib) and published to the web when merging into `develop`
5252
- [Inline documentation](https://code-corps.github.io/code-corps-api-github-pages) for the Elixir app generated by [`ex_doc`](https://github.com/elixir-lang/ex_doc) and published to GitHub pages when merging into `develop`
5353

54-
Want to improve the documentation? [Get started here.](CONTRIBUTING.md#what-kind-of-documentation-are-you-writing)
54+
Want to improve the documentation? [Get started here.](.github/CONTRIBUTING.md#what-kind-of-documentation-are-you-writing)
5555

5656
## Things we care about
5757

0 commit comments

Comments
 (0)