Skip to content

Latest commit

 

History

History
122 lines (78 loc) · 4.67 KB

CONTRIBUTING.md

File metadata and controls

122 lines (78 loc) · 4.67 KB
Raw

Contributing

Thank you for investing your time in contributing to our project! We encourage everyone to create pull requests, propose features and discuss issues.

(You could also check out our generic CONTRIBUTING.md file for more guidelines on contributing to this repository)

Developer Guidelines

Before you begin, check out our Developer Guidelines.

NOTE: This project uses checkstyle, to check its coding standard

Issues

Create a New Issue

If you spot an issue with this project, search if an issue already exists. If a related issue doesn't exist, you can open new issue using a relevant issue form.

Solve an Issue

Go through our existing issues to find one that interests you. You could also use labels as filters, to find the best issue for you.

Run the plugin

To run the plugin, use the following command, as described in the official documentation on running a plugin:

mvn hpi:run

For this to be successful, please make sure to either have Jenkins installed, or a docker image of Jenkins is available so that an instance is ready for launch for the testing. The default URL where Jenkins is set up in the browser is http://localhost:8080/jenkins/, where Jenkins can be accessed once up and running.

Make Changes

Fork the Project

Fork this project on GitHub and check out your copy of the repository, to get started making the contribution.

git clone https://github.com/contributor/conventional-commits-plugin.git
cd conventional-commits-plugin
git remote add upstream conventional-commits-plugin

Create a Branch

Make sure that your fork is up-to-date and create a topic branch for your feature or bug fix.

git checkout master
git pull upstream master
git checkout -b feature-branch

Run Maven

Build and run tests with mvn, make sure it outputs BUILD SUCCESS.

Write Tests

Make sure to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build.

Do take note to run the plugin tests with the following command:

mvn test

Be sure all the tests have been passed before submitting a PR for review. For more information about Jenkins testing in general, please checkout the official documentation on testing.

(We don't accept pull requests without tests.)

Commit Changes

First, make sure that git knows your name and email address.

git config --global user.name "Your Name"
git config --global user.email "[email protected]"

Once you are done writing the code, you could now make your commits.

Writing good commit messages is important. A commit message should exactly describe what was changed and why.

git add ...
git commit

Push

Once you're done making your commits, you can now push your code.

git push origin feature-branch

Pull Request

Once you're done making the changes, you can now open a pull request (PR). Go to the forked repository in GitHub (https://github.com/contributor/conventional-commits-plugin) and select your feature branch. Click the 'Pull Request' button and fill out the form.

While naming your Pull Request, make sure to start the title as follows:

  • wip: - For in progress
  • feat: - For enchancement
  • bug: , fix: - For bug
  • chore: - For chore
  • chore(deps) - For dependencies
  • docs: - For documentation

Pull requests are usually reviewed within a few days. (All checks in the pull request must be passed)

Rebase

If you've been working on a change for a while, it is very likely that some other changes are already made in the repository. To solve this problem, rebase with upstream/master.

git fetch upstream
git rebase upstream/master
git push origin my-feature-branch -f

That's it!

Thank you for taking your time to contributing to this project! We really appreciate your efforts! 🚀