Skip to content
This repository has been archived by the owner on Oct 15, 2018. It is now read-only.

Latest commit

 

History

History
104 lines (71 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

104 lines (71 loc) · 2.7 KB
Raw

Contributing to apiman-admin-client

Issue contributions

Did you find a bug ?

Open a new issue and be sure to include a title and clear description, as much relevant information as possible, and a code sample or a test case demonstrating the expected behavior that is not occurring.

Discussions can be done via github issues or IRC channel #bucharest-gold.

Code contributions

Fork

Fork the project on GitHub and check out your copy locally.

$ git clone git@github.com:username/apiman-admin-client.git
$ cd apiman-admin-client
$ git remote add upstream https://github.com/bucharest-gold/apiman-admin-client.git

Branch

Create a feature branch and start hacking:

$ git checkout -b my-contrib-branch

Commit messages

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.
  2. Keep the second line blank.
  3. Wrap all other lines at 72 columns.

Example of commit message:

fix a bug with download url.

The download url was not using https.
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.

Rebase to keep updated.

Use git rebase to sync your work from time to time.

$ git fetch upstream
$ git rebase upstream/master

Start server | Code - Test | Stop server

Bug fixes and features should come with tests. Add your tests in the test/apiman-test.js or test/util-test.js files.

To write the tests you will need docker installed and the server running, so run this script:

$ ./scripts/start-server.sh

This will pull and start the apiman docker image.

Then you can start coding and watching the results of the tests with this command:

$ make

You need to stop the server for each build to cleanup the apiman data by running this script:

$ ./scripts/stop-server.sh

Make sure the jshint and semistandard are happy and that all tests pass. Please, do not submit patches that fail either check.

Step 6: Push

$ git push origin my-contrib-branch

Go to https://github.com/yourusername/apiman-admin-client and select your feature branch. Click the 'Pull Request' button and fill out the form.