Skip to content
This repository has been archived by the owner on Jan 3, 2023. It is now read-only.

Commit

Permalink
Rephrase pull request template and contribuitng guide
Browse files Browse the repository at this point in the history
  • Loading branch information
lierdakil committed Jan 11, 2018
1 parent b9dd8e7 commit 2f45e23
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
10 changes: 8 additions & 2 deletions CONTRIBUTING.md
Expand Up @@ -16,8 +16,8 @@ Is rather simple. Here are 10 steps to get you running:
1. Fork the repo
2. Clone your fork
3. Run `npm install --only=dev` in addition to `apm install` in the
root of the working copy. Optionally `apm link` if you want to
test your changes in Atom.
root of the working copy. Optionally `apm link` if you want to test
your changes in Atom.
4. Hack on it using your favorite TypeScript package. There are a
couple packages in Atom to select from:
- <https://atom.io/packages/atom-typescript>
Expand All @@ -30,3 +30,9 @@ Is rather simple. Here are 10 steps to get you running:
9. Commit your changes. Don't forget to commit transpiled source in
`lib/`. Repeat steps 4-9 until satisfied.
10. Create a pull request.

**Note**: feel free to create pull requests at any stage of the process.
Earlier is usually better. For one, creating PRs early is a good way of
letting people know you're working on something, which helps avoid
effort duplication. Also it will allow maintainers to chime in early and
help you avoid pitfalls and common mistakes.
4 changes: 1 addition & 3 deletions pull_request_template.md
@@ -1,3 +1 @@
- [ ] `npm run test` passes locally
- [ ] `apm test` passes locally
- [ ] All compiled assets are included (atom packages are git tags and hence the built files need to be a part of the source control)
- [ ] I have looked over the [contribution guide](https://github.com/atom-community/markdown-preview-plus/blob/master/CONTRIBUTING.md), which contains some crucial technical information.

0 comments on commit 2f45e23

Please sign in to comment.