All development of Join Monster happens on GitHub. We actively welcome and appreciate your pull requests!
Bugs and feature requests are tracked via GitHub issues. Make sure bug descriptions are clear and detailed, with versions and stack traces. Provide your code snippets if any.
Begin by forking our repository and cloning your fork. Once inside the directory, run npm install and npm run db-build to prepare the fixture data. You'll need to provide a PostgreSQL URI in your environment in the PG_URL variable (omit the database name from the URI, but keep the trailing slash, e.g. postgres://user:pass@localhost/). Check the scripts in the package.json for easily running the example data and the demo server with GraphiQL. Now you can begin coding.
Before commiting your changes, run the lint, tests, and coverage to make sure everything is green. After making your commits, push it up to your fork and make a pull request to our master branch. We will review it ASAP.
We will make timely releases with any new changes, so you do not need to worry about publishing. Tagged commits to the master branch will trigger a new build on NPM. Travis-CI will publish the package. Do not publish manually from the command line.
New versions MUST be compliant with semver.
By contributing to Join Monster, you agree that your contributions will be licensed under the LICENSE file in the project root directory.