-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
#17 Signed-off-by: Alex Wilmer <[email protected]>
- Loading branch information
1 parent
5b443ae
commit 7105135
Showing
4 changed files
with
595 additions
and
242 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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, |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.