Skip to content

Latest commit

 

History

History
52 lines (31 loc) · 4.36 KB

CONTRIBUTING.md

File metadata and controls

52 lines (31 loc) · 4.36 KB
Raw

Contributing to VersionOne SDK.JavaScript Library

  1. Getting Involved
  2. Reporting Bugs
  3. Improving Documentation
  4. Contributing Code

Getting Involved

We need your help to make the VersionOne SDK.JavaScript Library a useful tool for developing integrations and complementary applications. While third-party patches are absolutely essential, they are not the only way to get involved. You can help the project by discovering and reporting bugs, improving documentation, and helping others on the versionone-dev group and GitHub issues.

Reporting Bugs

Before reporting a bug on the project's issues page, first make sure that your issue is caused by the Library, not your application code (e.g. passing incorrect arguments to methods, etc.). Second, search the already reported issues for similar cases, and if it has been reported already, just add any additional details in the comments.

After you made sure that you have found a new bug, here are some tips for creating a helpful report that will make fixing it much easier and quicker:

  • Write a descriptive, specific title. Bad: Problem with filtering. Good: Scope.Workitems always returns an empty list.
  • Whenever possible, include Function info in the description.
  • Create a simple test case that demonstrates the bug.

Improving Documentation

All documentation and examples are located in the gh-pages branch. The easiest way to make little improvements such as fixing typos without even leaving the browser is by editing one of the files with the online GitHub editor: browse the gh-pages branch, choose a certain file for editing, click the Edit button, make changes and follow instructions from there. Once it gets merged, the changes will immediately appear on the website.

If you need to make edits in a local repository to see how it looks in the process, do the following:

  1. Install Ruby if do not have it yet.
  2. Run gem install jekyll.
  3. Run jekyll --auto inside the VersionOne.SDK.JavaScript folder.
  4. Open the website from the _site folder.

Now any file changes will be reflected on the generated pages automatically. After commiting the changes, just send a pull request.

If you need to update documentation according to a new feature that only appeared in the master version (not stable one), you need to make changes to gh-pages-master branch instead of gh-pages. It will get merged into the latter when released as stable.

Contributing Code

Making Changes to Source

If you are not yet familiar with the way GitHub works (forking, pull requests, etc.), be sure to read the article about forking on the GitHub Help website — it will get you started quickly.

You should always write each batch of changes (feature, bugfix, etc.) in its own topic branch. Please do not commit to the master branch, or your unrelated changes will go into the same pull request.

You should also follow the code style and whitespace conventions of the original codebase.

Considerations for Accepting Patches

Before sending a pull request with a new feature, first check if it has been discussed before already (either on GitHub issues. If your feature or API improvement did get merged into master, please consider submitting another pull request with the corresponding documentation update.

Open Source Licenses and Attribution

Regardless of whether attribution is required by included code or a dependency, we want to acknowledge the work that VersionOne.SDK.JavaScript depends on and make it easy for people to evaluate the legal implications of using this library. Therefore, all dependencies should be attributed in the ACKNOWLEDGEMENTS.md. This should include the persons or organizations who contributed the libraries, a link to the source code, and a link to the underlying license.