postcss-editor-styles
Version:
Remove your editor-styles from the global scope
66 lines (50 loc) • 1.9 kB
Markdown
# Contributing to PostCSS Editor Styles
You want to help? You rock! Now, take a moment to be sure your contributions
make sense to everyone else.
## 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 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 git@github.com:YOUR_USER/postcss-editor-styles.git
# Navigate to the newly cloned directory
cd postcss-editor-styles
# Assign the original repo to a remote called "upstream"
git remote add upstream git@github.com:jonathantneal/postcss-editor-styles.git
# Install the tools necessary for testing
npm install
```
2. Create a branch for your feature or fix:
```bash
# Move into a new branch for your feature
git checkout -b feature/thing
```
```bash
# Move into a new branch for your fix
git checkout -b fix/something
```
3. If your code follows our practices, then push your feature branch:
```bash
# Test current code
npm test
```
```bash
# Push the branch for your new feature
git push origin feature/thing
```
```bash
# Or, push the branch for your update
git push origin update/something
```
That’s it! Now [open a pull request] with a clear title and description.
[already been reported]: issues
[fork this project]: fork
[live example]: https://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/