Skip to content

Commit

Permalink
Merge pull request #152 from sudz123/update-contrib
Browse files Browse the repository at this point in the history
Contributing.md: Added instruction video for getting started
  • Loading branch information
scrabill committed Oct 3, 2018
2 parents 172a913 + 9cb167d commit ae22d89
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,26 @@ It's simple: All you need to do is visit our [page][link] and it will do the cou

We hope your Halloween is fun and spooky. Eat, drink and be scary! :jack_o_lantern: :ghost:

## Contributing Code ##
## How do I start contributing? ##

If you want to contribute code, we suggest you to fork the repository first, select an issue, make your changes and submit a pull request for that issue. You can suggest new features, fix an existing functionality for performance or readability, work on open issues, etc.
Well before you can contribute you need to set up git on your PC, fork and clone this repository and a lot more of groundwork. Follow [this][link] video to get started. Once everything is setup, you can go to the issues tab and select one that interests you. After fixing it, you can submit a Pull Request. Make sure that you browse through other videos on that site to understand how to go about this.

[link]: https://egghead.io/lessons/javascript-how-to-fork-and-clone-a-github-repository

Key areas of code contributions include:

- [New features](https://github.com/scrabill/how-many-days-until-halloween/issues/1)
- [Documentation](https://github.com/scrabill/how-many-days-until-halloween/issues?q=is%3Aissue+is%3Aopen+label%3Adocumentation)
- [Enhancements](https://github.com/scrabill/how-many-days-until-halloween/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement)

When working on an issue, see if the update/fix already has a pending [pull request](https://github.com/scrabill/how-many-days-until-halloween/pulls). New pull requests are always welcome, however, duplicate pull requests will not be merged.
When working on an issue, see if the update/fix already has a pending [pull request](https://github.com/scrabill/how-many-days-until-halloween/pulls). New pull requests are always welcome, however, duplicate pull requests will not be merged. You can always add new commits to the existing pull request before it is merged. It will get automatically updated.

When creating a pull request, if it applies, close or link to the issue it resolves in your comments. See [GitHubs documentation](https://help.github.com/articles/closing-issues-using-keywords/) on how to do this.

Make sure you are registered for the [HacktoberFest] before you start!(https://hacktoberfest.digitalocean.com/)

Also, if you want to run the site locally and take a look at your changes, just open **index.html** with a browser.

## Current Status ##

The project has a landing page which displays a static message saying how many days are remaining to the Halloween.
Expand All @@ -54,6 +61,7 @@ To get you started, some of the following links can be useful:
- [Markdown](https://www.markdowntutorial.com)

### Quick links

- [JavaScript folder](https://github.com/scrabill/how-many-days-until-halloween/tree/master/js)
- [CSS folder](https://github.com/scrabill/how-many-days-until-halloween/tree/master/css)
- [Fonts folder](https://github.com/scrabill/how-many-days-until-halloween/tree/master/fonts)
Expand Down

0 comments on commit ae22d89

Please sign in to comment.