-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
63 additions
and
1 deletion.
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,10 @@ | ||
# editorconfig.org | ||
|
||
root = true | ||
|
||
[*] | ||
charset = utf-8 | ||
end_of_line = lf | ||
indent_size = 2 | ||
indent_style = space | ||
insert_final_newline = true |
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,52 @@ | ||
## Reporting Issues | ||
|
||
Found a problem? Want a new feature? | ||
|
||
- See if your issue or idea has [already been reported]. | ||
- Provide a [reduced test case] or a [live example]. | ||
|
||
Remember, a bug is a _demonstrable problem_ caused by _our_ code. | ||
|
||
## Submitting Pull Requests | ||
|
||
Pull requests are the greatest contributions, so be sure they are focused in scope, and do avoid unrelated commits. | ||
|
||
1. To begin, [fork this project], clone your fork, and add our upstream. | ||
```bash | ||
# Clone your fork of the repo into the current directory | ||
git clone https://github.com/<your-username>/avalanche | ||
# Navigate to the newly cloned directory | ||
cd avalanche | ||
# Assign the original repo to a remote called "upstream" | ||
git remote add upstream https://github.com/avalanchesass/avalanche | ||
# Install the tools necessary for development | ||
npm install | ||
``` | ||
|
||
2. Create a branch for your feature or hotfix: | ||
```bash | ||
# Move into a new branch for a feature | ||
git checkout -b feature/thing | ||
``` | ||
```bash | ||
# Move into a new branch for a hotfix | ||
git checkout -b hotfix/something | ||
``` | ||
|
||
3. Push your branch up to your fork: | ||
```bash | ||
# Push a feature branch | ||
git push origin feature/thing | ||
``` | ||
```bash | ||
# Push a hotfix branch | ||
git push origin hotfix/something | ||
``` | ||
|
||
4. Now [open a pull request] with a clear title and description. | ||
|
||
[already been reported]: https://github.com/avalanchesass/avalanche/issues | ||
[fork this project]: https://github.com/avalanchesass/avalanche/fork | ||
[live example]: http://codepen.io/pen | ||
[open a pull request]: https://help.github.com/articles/using-pull-requests/ | ||
[reduced test case]: https://css-tricks.com/reduced-test-cases/ |
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