diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 1ff39ef..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,55 +0,0 @@ -# Contributing to RouterRouter - -I'd love to have your help improving RouterRouter! If you'd like to pitch in, you can do so in a number of ways: - -1. Look through open [Issues](https://github.com/jgarber623/RouterRouter/issues). -1. Review any open [Pull Requests](https://github.com/jgarber623/RouterRouter/pulls). -1. [Fork RouterRouter](#get-set-up-to-contribute) and fix an open Issue or add your own feature. -1. File new Issues if you have a good idea or see a bug and don't know how to fix it yourself. _Only do this after you've made sure the behavior or problem you're seeing isn't already documented in an open Issue._ - -I definitely appreciate your interest in (and help improving) RouterRouter. Thanks! - -## Install development dependencies - -RouterRouter's build process uses [npm](https://www.npmjs.com) and [Node.js](https://nodejs.org). If you're using a Mac, the easiest way to install npm and Node.js (and plenty of other great tools) is with [Homebrew](https://brew.sh): - -```sh -brew install node -``` - -If you're using a different operating system, use a different package manager, or prefer not to use Homebrew, check out the [Node.js Downloads page](https://nodejs.org/en/download/). - -## Get set up to contribute - -Contributing to RouterRouter is pretty straightforward: - -1. Fork the RouterRouter repo and clone it. -1. Install development dependencies by running `npm install` from the root of the project. -1. Create a feature branch for the issue or new feature you're looking to tackle: `git checkout -b your-descriptive-branch-name`. -1. Run `npm start` which instructs [Rollup](https://rollupjs.org) to watch `src/routerrouter.mjs` for changes and automatically exports built files to the `dist` folder. -1. _Write some code!_ -1. If your changes would benefit from testing, add the necessary tests and verify everything passes by running `npm test`. -1. Commit your changes: `git commit -am 'Add some new feature or fix some issue'`. -1. Push the branch to your fork of RouterRouter: `git push origin your-descriptive-branch-name`. -1. Create a new Pull Request and I'll give it a look! - -## "But which files do I change?!?" - -Excellent question. RouterRouter's source code is in the file `src/routerrouter.mjs`. Make your changes here! - -When you're done working (and before you push your code or issue a pull request), run `npm run build` from the root of the project to recreate the files in the `dist` folder. This task will generate compiled and compressed versions of the project. - -**Do not directly edit the files in the `dist` folder!** - -## Code Style - -Code styles are like opinions: Everyone's got one and yours is better than mine. Here's how RouterRouter should be written: - -- Use two spaces for indentation. -- No trailing whitespace and blank lines should have whitespace removed. -- Prefer single quotes over double quotes unless interpolating. -- Follow the conventions you see in the existing source code as best as you can. - -RouterRouter's formatting guidelines are defined in the `.editorconfig` file which uses the [EditorConfig](http://editorconfig.org) syntax. There are [a number of great plugins for a variety of editors](http://editorconfig.org/#download) that utilize the settings in the `.editorconfig` file. Using EditorConfig will make your time spent coding a little bit easier. - -Your bug fix or feature addition won't be rejected if it runs afoul of any (or all) of these guidelines, but following the guidelines will definitely make everyone's lives a little easier.