Skip to content

Commit

Permalink
📝 contributing docs + gitmoji-cli
Browse files Browse the repository at this point in the history
 #17

Signed-off-by: Alex Wilmer <[email protected]>
  • Loading branch information
alex-wilmer committed Apr 23, 2017
1 parent 5b443ae commit 7105135
Show file tree
Hide file tree
Showing 4 changed files with 595 additions and 242 deletions.
47 changes: 47 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
## Contributing to torontojs.com

Thanks for your interest in contributing to the Toronto JS community website! Please
reference this document prior to submitting a pull request in order to skip some back and forth that may happen.

### Create an issue

If you have found a bug, are requesting a feature, or anything related to this website, please make an issue for it before submitting a pull request. It's possible that someone is already working on it!

We will get back to you as soon as possible. If your issue has not received a response within a few days, feel free to ping one of the maintainers on the toronto.js slack channel, depending on the urgency of the issue. Use your best judgement!

### Pull requests

So you've got the green light to create a pull request. Assuming you have already forked the repo, you'll need to name your branch.

#### Branch names

Branches come and go and as such their names are not super important. It's still best to give them a meaningful name, one that people can make a reasonable assumption about the changes without needing to run the code or check the diff.

Good examples:

```
add_about_page, fix/nav_bug, upgrade_deps
```

Bad examples:

```
cool_thing, alexs_branch, fix/203
```

#### Commits

[gitmoji](https://gitmoji.carloscuesta.me/) is used to standardize commit messages and make the process super fun. 😂

Create a commit:

```
yarn commit
```

Good example:

![gitmoji_proper_commit](public/commit.png)

**Note:** If the title is sufficient, the message can be left blank,
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
"eslint-plugin-import": "^2.2.0",
"eslint-plugin-react": "^6.10.3",
"gh-pages": "^0.12.0",
"gitmoji-cli": "^1.5.2",
"react-scripts": "^0.9.5"
},
"dependencies": {
Expand All @@ -27,6 +28,7 @@
"build": "react-scripts build",
"deploy": "npm run build&&gh-pages -d build",
"test": "react-scripts test --env=jsdom",
"eject": "react-scripts eject"
"eject": "react-scripts eject",
"commit": "gitmoji -c"
}
}
Binary file added public/commit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 7105135

Please sign in to comment.