Backbone.EventRouter follows very similar guidelines to Marionette. These guidelines are here to facilitate your contribution and streamline the process of getting the changes merged in and released.
git clone git@github.com:RoundingWellOS/backbone.eventrouter.git && cd backbone.eventrouter
Make sure Node.js v4+ and npm are installed. If you need multiple node version installs try nvm.
$ npm install
There are two methods to running the unit test suite, suited
for your desired workflow and overall developer happiness:
you can open runner.html in the browser or run gulp test
Optionally run gulp test-browser to live reload the tests after
either the tests or src js change.
Open runner.html in your browser.
Running gulp test will run the tests after linting.
If you notice any problems with any documentation, please fix it and we'll get it merged as soon as we can. For small things like typos and grammar (which we know I'm terrible with), just click the "Edit this file" button and send in the pull request for the fix. For larger changes and big swaths of documentation changes, a regular pull request as outlined below is more appropriate.
See Github's documentation for pull requests.
Pull requests are by far the best way to contribute to Backbone.EventRouter. Any time you can send us a pull request with the changes that you want, we will have an easier time seeing what you are trying to do. But a pull request in itself is not usually sufficient. There needs to be some context and purpose with it, and it should be done against a specific branch.
Try and stick to Backbone.EventRouter's existing coding conventions (just use the file you're editing as a guideline). Installing the appropriate EditorConfig plugin for your code editor will help with this.
While this library uses the babel transpiler, it supports IE8, so these caveats must be respected.
These guidelines are generally applicable whether or not you are submitting a bug or a pull request. Please try to include as much of this information as possible with any submission.
In order to best help out with bugs, we need to know the following information in your bug submission:
- Backbone version #
- Operating System / version #
- Browser and version #
- Backbone.Radio version #
Including this information in a submission will help us to test the problem and ensure that the bug is both reproduced and corrected on the platforms / versions that you are having issues with.
It doesn't matter how beautiful and "obvious" your fix is. It is very important to provide a meaningful description with your pull requests that alter any code. A good format for these descriptions will include three things:
-
Why: The problem you are facing (in as much detail as is necessary to describe the problem to someone who doesn't know anything about the system you're building)
-
What: A summary of the proposed solution
-
How: A description of how this solution solves the problem, in more detail than item #2
-
Any additional discussion on possible problems this might introduce, questions that you have related to the changes, etc.
Without at least the first 2 items in this list, we won't have any clue why you're changing the code. The first thing we'll ask, then, is that you add that information.
Please refrain from giving code examples in altJS languages like CoffeeScript, etc. Backbone.EventRouter is written in plain-old JavaScript and is generally easier for all members in the community to read.
The work you are doing for your pull request should not be done in the master branch of your forked repository. Create a topic branch for your work. This allows you to isolate the work you are doing from other changes that may be happening.
Github is a smart system, too. If you submit a pull request from a topic branch and we ask you to fix something, pushing a change to your topic branch will automatically update the pull request.
See the previous item on creating a topic branch.
If you don't use a topic branch, we may ask you to re-do your pull request on a topic branch. If your pull request contains commits or other changes that are not related to the pull request, we will ask you to re-do your pull request.
README and unit test updates can be opened against Master.
All other code changes should go against the "develop" branch.
Whenever possible, submit the specs (unit tests) that correspond to your pull request.
I would rather see a pull request that is nothing but a failing spec, than see a large change made to the real code with no test to support the change.
In fact...
If you are stuck in a scenario that fails in your app, but you don't know how to fix it, submit a failing spec to show the failing scenario. Follow the guidelines for a pull request submission, but don't worry about fixing the problem. A failing spec to show that a problem exists is a very very very helpful pull request for us.
We'll even accept a failing test pasted in to the ticket description instead of a pull request. That would at least get us started on creating the failing test in the code.