Skip to content

Commit

Permalink
chore: Update Contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sapegin committed Sep 14, 2023
1 parent ee2224a commit ca36a64
Showing 1 changed file with 1 addition and 18 deletions.
19 changes: 1 addition & 18 deletions Contributing.md
@@ -1,28 +1,11 @@
# How to contribute

I love pull requests. And following this simple guidelines will make your pull request easier to merge.

## Submitting pull requests

1. Create a new branch, please don’t work in master directly.
2. Add failing tests (if there’re any tests in project) for the change you want to make. Run tests (see below) to see the tests fail.
3. Hack on.
4. Run tests to see if the tests pass. Repeat steps 2–4 until done.
5. Update the documentation to reflect any changes.
6. Push to your fork and submit a pull request.
Bug fixes are welcome, but not new features. [See more details](https://github.com/sapegin/textlint-rule-terminology/discussions/65).

## JavaScript code style

[See here](https://github.com/tamiadev/eslint-config-tamia#code-style-at-a-glance).

## Other notes

- If you have commit access to repo and want to make big change or not sure about something, make a new branch and open pull request.
- Don’t commit generated files: compiled from Stylus CSS, minified JavaScript, etc.
- Don’t change version number and changelog.
- Install [EditorConfig](http://editorconfig.org/) plugin for your code editor.
- Feel free to [ask me](http://sapegin.me) anything you need.

## Building and running tests

Install dependencies:
Expand Down

0 comments on commit ca36a64

Please sign in to comment.