Contributing

Help us to make this project better by contributing. Whether it’s new features, bug fixes, or simply improving documentation, your contributions are welcome. Please start with logging a JIRA and submit a pull request.

Before you contribute, please review these guidelines to help ensure a smooth process for everyone. Thanks :).

Issue reporting

• Please browse our existing issues before logging new issues.
• Check that the issue was not already fixed in the master branch.
• Open an issue with a descriptive title and a summary.
• Please be as clear and explicit as you can in your description of the issue.
• Include any relevant code in the issue summary.

Pull requests

• Follow Standard procedures in contributing to open source projects on Github.
  • Fork the project.
  • Use a feature branch.
  • Add good commit messages.
  • Use the same coding conventions as the rest of the project. This project is using Google StyleGuide.
  • Download StyleGuides from Github.
  • Commit locally and push to your fork until you are happy with your improvements.
  • Make sure to add tests and verify all the tests are passing when merging upstream.
  • Add an entry to the Release notes accordingly.
  • Squash commits before merging to master.
  • Open a pull request.
  • The pull request will be reviewed by the community and merged by the project committers.

Development

• Fork the repository.
• Clone the forked repository.
• Make the code changes.
• Add Tests
• Open a pull request directly from the forked repository.

Testing

• Spin up docker instances for JIRA and JENKINS locally or install JIRA and JENKINS on your machine.
• Configure Jenkins
• Run mvn package from command line or terminal.
• jira-steps-plugin.hpi file can be found in target folder of the project.
• Install plugin manually using .hpi file in jenkins.
• Test your functionality.
• It helps reviewers if the screenshots of these evidences are added in the pull request.

Note: This plugin requires JDK 1.8 and latest maven version to build.

Updating Documentation

• This plugin currently using github pages site for hosting the project documentation.
• Documentation can be updated and a pull request can be issued by changing site pages in jira-steps-plugin/docs/pages/ folder.
• Once the changes are committed on your branch, merge it to master branch of your fork and go to settings > github pages and select source as master branch/docs folder.
• Site will be published at https://YourUserName.github.io/jira-steps-plugin/
• More information about Jekyll Setting up GitHub Pages site locally with Jekyll.