-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* create separate DOCS file * add markdown-toc for generating TOC of DOCS file * update rasti logo
- Loading branch information
Showing
8 changed files
with
1,090 additions
and
309 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,36 @@ | ||
# 🍻 Contributing | ||
|
||
Thanks for your interest in rasti.js! | ||
|
||
## Submitting an Issue | ||
|
||
Please note that the issue tracker is meant for: | ||
|
||
1. Bug reports. | ||
2. Feature requests. | ||
|
||
Before submitting an issue, **please look carefully through the following places** to make sure your problem is not already addressed: | ||
|
||
1. The [issue tracker](https://github.com/kareraisu/rasti.js/issues). | ||
2. The [README](README.md). | ||
|
||
|
||
## Opening a Pull Request | ||
|
||
Pull Requests fixing bugs, implementing new features, or updating documentation and dependencies are all very welcome! If you would like to help out with the project, you can pick an open issue from the issue tracker. We're more than happy to help you get started! Here's how you can proceed: | ||
|
||
1. Fork this repo. | ||
2. Clone your fork: | ||
`$ git clone https://github.com/(your-username)/rasti.js.git` | ||
3. cd into your local copy: | ||
`$ cd rasti.js` | ||
4. Create a topic branch with a sensible name for your contribution, for example: | ||
`$ git checkout -b fix/sth-broken` or | ||
`$ git checkout -b feat/new-cool-feat`. | ||
5. Install dependencies (install [Node.js](https://nodejs.org/) first if you don't have it): | ||
`$ npm install` | ||
6. Start the dev server (this also generates the bundles and watches all the files, see the gulpfile.js if curious): | ||
`$ npm start` | ||
7. Hack away. | ||
8. Commit and push your changes to your fork. | ||
9. Make a Pull Request to kareraisu/rasti. |
Oops, something went wrong.