Skip to content

Latest commit

 

History

History
242 lines (162 loc) · 7.33 KB

CONTRIBUTING.md

File metadata and controls

242 lines (162 loc) · 7.33 KB
Raw

Contributing to ml-search-ng

ml-search-ng welcomes new contributors. This document will guide you through the process.

Got a Question or Problem?

If you have questions about how to use ml-search-ng, check the README. Alternatively, check our GitHub Issue Tracker to see if it has been answered there, and post your question there if not.

Found an Issue?

If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to our GitHub Issue Tracker. Even better you can submit a Pull Request with a fix for the issue you filed.

Want a Feature?

You can request a new feature by submitting an issue to our GitHub Issue Tracker. If you would like to implement a new feature then first create a new issue and discuss it with one of our project maintainers.

Submission Guidelines

Submitting an Issue

Before you submit your issue search the archive, maybe your question was already answered.

If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. Providing the following information will increase the chances of your issue being dealt with quickly:

  • Overview of the Issue - if an error is being thrown a stack trace helps
  • Motivation for or Use Case - explain why this is a bug for you
  • ml-search-ng Version - is it a named version or from our master branch
  • Operating System - Mac, windows? details help
  • Suggest a Fix - if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit)

Submitting a Pull Request

Fork ml-search-ng

Fork the project on GitHub and clone your copy.

$ git clone git@github.com:username/ml-search-ng.git
$ cd ml-search-ng
$ git remote add upstream git://github.com/joemfb/ml-search-ng.git

All bug fixes and new features go into the master branch.

We ask that you open an issue in the issue tracker and get agreement from at least one of the project maintainers before you start coding.

Nothing is more frustrating than seeing your hard work go to waste because your vision does not align with that of a project maintainer.

Create a branch for your changes

Okay, so you have decided to fix something. Create a feature branch and start hacking:

$ git checkout -b issuenr-my-feature-branch -t origin/master

Formatting code

We use .editorconfig to configure our editors for proper code formatting. If you don't use a tool that supports editorconfig be sure to configure your editor to use the settings equivalent to our .editorconfig file.

Commit your changes

Make sure git knows your name and email address:

$ git config --global user.name "J. Random User"
$ git config --global user.email "j.random.user@example.com"

Writing good commit logs is important. A commit log should describe what changed and why. Follow these guidelines when writing one:

  1. The first line should be 50 characters or less and contain a short description of the change including the Issue number prefixed by a hash (#).
  2. Keep the second line blank.
  3. Wrap all other lines at 72 columns.

A good commit log looks like this:

Fixing Issue #123: make the whatchamajigger work in Vagrant

Body of commit message is a few lines of text, explaining things
in more detail, possibly giving some background about the issue
being fixed, etc etc.

The body of the commit message can be several paragraphs, and
please do proper word-wrap and keep columns shorter than about
72 characters or so. That way `git log` will show things
nicely even when it is indented.

The header line should be meaningful; it is what other people see when they run git shortlog or git log --oneline.

Rebase your repo

Use git rebase (not git merge) to sync your work from time to time.

$ git fetch upstream
$ git rebase upstream/master

Exclude dist/

Our gulp build scripts create distribution artifacts in dist/ by concatenating and minify'ing the project source. Changes to these distribution files are only committed as part of project releases, so please exclude the dist/ directory from your changes.

Check Test Coverage

We try to maintain complete unit test coverage for ml-search-ng. High-level code coverage statistics are displayed by the test harness.

gulp test

A detailed HTML code coverage report is available in coverage/PhantomJS 1.9.8 {OS OS_VERSION}/index.html. If the high-level statistics show less than 100% coverage, inspect your changes in the detailed report to confirm that they are covered by your tests.

Check Docs

We use JSDoc3 to generate documentation for ml-search-ng. If your changes include documentation changes, regenerate the documentation:

gulp docs

and inspect them to make sure they're appropriately formatted (docs/generated/index.html)

Push your changes

$ git push origin issuenr-my-feature-branch

Submit the pull request

Go to https://github.com/username/ml-search-ng and select your feature branch. Click the 'Pull Request' button and fill out the form.

Pull requests are usually reviewed within a few days. If you get comments that need to be to addressed, apply your changes in a separate commit and push that to your feature branch. Post a comment in the pull request afterwards; GitHub does not send out notifications when you add commits to existing pull requests.

That's it! Thank you for your contribution!

After your pull request is merged

After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:

  • Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:

    git push origin --delete issuenr-my-feature-branch

  • Check out the master branch:

    git checkout master -f

  • Delete the local branch:

    git branch -D issuenr-my-feature-branch

  • Update your master with the latest upstream version:

    git pull --ff upstream master

Release Process

For purposes of clarity, here is the process to create new releases of ml-search-ng.

Update dependencies:

bower update

Bump the version number in package.json and bower.json.

Run the build script (building distribution assets in dist/), and confirm test coverage and lint compliance:

gulp

Build the docs:

gulp docs

Review docs/generated/index.html, checking changes, new features, formatting, etc.

Release:

git add dist/
git add package.json
git add bower.json

git commit -m "v$version"
git tag "v$version"
git push origin master --tags

Publish docs to https://joemfb.github.io/ml-search-ng/:

gulp publish-docs