Skip to content

Latest commit

 

History

History
83 lines (55 loc) · 4.08 KB

CONTRIBUTING.md

File metadata and controls

83 lines (55 loc) · 4.08 KB

Contributing to WildFly Github Bot

Welcome to the WildFly Github Bot project and thank you for deciding to contribute to this project! We welcome contributions from the community. This guide will walk you through the steps for getting started on our project.

Forking the Project

First of all, you will need to fork the repository.

This can be done by going to your newly forked repository, which should be at https://github.com/USERNAME/wildfly-github-bot.

Then, there will be a green button that says "Code". Click on that and copy the URL.

Then, in your terminal, paste the following command:

git clone [URL]

Be sure to replace [URL] with the URL that you copied.

Now you have this repository on your computer!

Issues

The WildFly Github bot project currently uses Github issues as means of filing new issues.

To create an issue simple click on tab "Issues" and then on the button "New issue"

Good First Issues

If you would like to contribute, however you are not quite confident, do not hesitate to start with the good-first-issue labeled issues. These are a triaged set of issues that are great for getting started on our project. These can be found here.

Once you have selected an issue you'd like to work on, make sure you write a comment to the corresponding issue stating, you would like to work on it, so others are aware of it such as this.

It is recommended that you use a separate branch for every issue you work on. We would recommend you naming the branch corresponding to the issue you are solving. This can be achieved with git checkout -b issue-123

Setting up your Developer Environment

You will need:

First cd to the directory where you cloned the project (eg: cd wildfly-github-bot)

Add a remote ref to upstream, for pulling future updates, i.e. synchronizing the this repository. For example:

git remote add upstream https://github.com/wildfly/wildfly-github-bot.git

Running the github bot

Not so quick coding hero! You will need to create your own instance of the github app to be able to run the github bot. Please follow this guide

Note: This is not needed for test mode

Finally, we can run the github bot:

./mvnw clean quarkus:dev

Or to run only tests use:

./mvnw clean quarkus:test

Contributing Guidelines

When submitting a PR, please keep the following guidelines in mind:

  1. In general, it's good practice to squash all of your commits into a single commit. For larger changes, it's ok to have multiple meaningful commits. If you need help with squashing your commits, feel free to ask us how to do this on your pull request. We're more than happy to help!

  2. Please include the github issue you worked on in the description of your pull request and in your commit message. For example, working on issue 123 would result in description stating something as Resolves #123. This is done in order to automatically link issues and close them with merging the PullRequest see here

  3. If it so happened, that you solved multiple issues in the same Pull Request, please include all of them in the description.

For example a Pull Request can look like this