Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

create PR template #853

Closed
wants to merge 2 commits into from
Closed

create PR template #853

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
490ba20
create .github/ and PR template (closes #847)
Jun 27, 2017
d22f38b
incorporate reviewer advice
Jun 27, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 0 additions & 11 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ themselves. There are other guides about contributing to other parts of the Exer
* [Starting a New Track](#starting-a-new-track)
* [Beta-Testing a Language Track](#beta-testing-a-language-track)
* [Useful Tidbits](#useful-tidbits)
* [Pull Request Guidelines](#pull-request-guidelines)
* [Exercise Versioning](#exercise-versioning)
* [Anatomy of an Exercise](#anatomy-of-an-exercise)
* [Track configuration file (config.json)](#track-configuration-file)
Expand Down Expand Up @@ -159,10 +158,6 @@ Once you've updated the test suite, there are a few things you'll want to check.
You can also take a look at the `.travis.yml` file to see what the continuous
integration system will do to verify the track.

Take a look at our [pull request guidelines](#pull-request-guidelines).
You don't need to get it perfect the first time around; we'll work with you to
get the patch merged.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[…] documentation of how to write a pull request has been extracted from CONTRIBUTING.md and added to a separate PULL_REQUEST_TEMPLATE.md document?

@Insti: I have extracted barely more than links (above & below this comment). The actual advice is still at the link targets. How about not deleting those lines here, but duplicating them in the PR template?

Copy link
Contributor

@Insti Insti Jul 6, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But you have (had) extracted it from CONTRIBUTING.md and moved it into PULL_REQUEST_TEMPLATE.md

I thought that they were still relevant in CONTRIBUTING.md to someone who is reading through that file who might not be making a pull request right now but might want to later.

I would probably suggest creating an explicit "Writing a Pull request" section in CONTRIBUTING.md that contained the relevant information (this may still be a useful change.) and then referring to THAT from the Pull Request Template.

Another possibility would be to greatly simplify the CONTRIBUTING.md file which is linked to in the yellow box, and moving all the information that is not directly related to creating a pull request to a different file.

### Updating a Generated Test Suite

Some language tracks are experimenting with generating test suites from shared
Expand Down Expand Up @@ -333,10 +328,6 @@ You can include advice and helpful links for your language track in the
Here are a few bits and pieces that are referenced from some of the
scenarios in this guide.

### Pull Request Guidelines

See the [pull request guidelines](https://github.com/exercism/docs/blob/master/contributing-to-language-tracks/pull-request-guidelines.md) in the docs repository.

### Exercise Versioning

It's only when we get a bunch of people having conversations about the
Expand All @@ -361,8 +352,6 @@ the reference solution. If the change you're making is backwards-incompatible,
then please increment the version in both the test suite and the reference
solution.

Please review the details in [README.md](https://github.com/exercism/problem-specifications#test-data-versioning) and bump the version number accordingly.

### Anatomy of an Exercise

TODO: expand on notes below.
Expand Down
9 changes: 9 additions & 0 deletions PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Hello, and thanks for contributing to Exercism!

In order to help your fellow volunteers, please note the following suggestions. Feel free to `[x]`-check or remove them afterwards. Use `Preview` to activate hyperlinks ;-)

- [ ] Please read and apply the [Pull Request Guidelines](https://github.com/exercism/docs/blob/master/contributing-to-language-tracks/pull-request-guidelines.md).
- [ ] Please check the [contributing guide's](https://github.com/exercism/problem-specifications/blob/master/CONTRIBUTING.md#contributing) `Table of Contents` and read the relevant sections.
- [ ] Lastly, in case this PR modifies `canonical-data.json`, please apply [our versioning guidelines](https://github.com/exercism/problem-specifications#test-data-versioning).

You don't need to get this perfect right away. We'll help getting your pull request merged :-)
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Shared metadata for Exercism exercises.

## Contributing Guide

Please see the [contributing guide](https://github.com/exercism/problem-specifications/blob/master/CONTRIBUTING.md)
Please see the [contributing guide](https://github.com/exercism/problem-specifications/blob/master/CONTRIBUTING.md) and the [pull request template](https://github.com/exercism/problem-specifications/blob/master/PULL_REQUEST_TEMPLATE.md).

## Problem metadata

Expand Down