Skip to content

Commit

Permalink
Reference to Ramda Conventions wiki page (#2718)
Browse files Browse the repository at this point in the history
  • Loading branch information
tommmyy authored and CrossEye committed Jan 16, 2019
1 parent 878cacd commit 626762b
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions CONTRIBUTING.md
Expand Up @@ -2,27 +2,29 @@

1. Fork the project and clone your fork.

2. Create a local feature branch:
1. Create a local feature branch:

$ git checkout -b <branch>

3. If adding a function `R.foo`, define it in `source/foo.js`, export it from
1. If adding a function `R.foo`, define it in `source/foo.js`, export it from
`source/index.js`, and include unit tests in `test/foo.js`. It is not necessary
to include the `@since` annotation for new functions as it will be set
during the release process of the following release. If adding an internal
function `_foo`, define it in `source/internal/_foo.js`.

4. Make one or more atomic commits. Each commit should have a descriptive
1. Before designing a new function please read our [Ramda Conventions](https://github.com/ramda/ramda/wiki/Ramda-Conventions) article.

1. Make one or more atomic commits. Each commit should have a descriptive
commit message, wrapped at 72 characters. Do not commit changes to
`dist/ramda.js`.

5. Run `npm test` (or `make test lint`) and address any errors. It will install
1. Run `npm test` (or `make test lint`) and address any errors. It will install
needed dependencies locally. Preferably, fix commits in place using `git
rebase` or `git commit --amend` to make the changes easier to review and to
keep the history tidy.

6. Push to your fork:
1. Push to your fork:

$ git push origin <branch>

7. Open a pull request.
1. Open a pull request.

0 comments on commit 626762b

Please sign in to comment.