We need your help to make the VersionOne JavaScript PipelineBuidler Library a useful tool. 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 GitHub issues.
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: Promblem with Jenkins Plugin. Good: Jenkins get_build_plugin returns an empty object.
- Whenever possible, include Function info in the description.
- Create a simple test case that demonstrates the bug.
All documentation and examples are located in the project's wiki. Community driven documentation improvement is a pending feature.
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.
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.
Regardless of whether attribution is required by included code or a dependency, we want to acknowledge the work that VersionOne.JavaScript.PipelineBuilder 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.