Skip to content

Latest commit

 

History

History
69 lines (45 loc) · 2.72 KB

CONTRIBUTING.md

File metadata and controls

69 lines (45 loc) · 2.72 KB

Contributing to WildFly S2I project

Welcome to the WildFly S2I project! We welcome contributions from the community. This guide will walk you through the steps for getting started on our project.

Forking the Project

To contribute, you will first need to fork the wildfly-s2i repository.

This can be done by looking in the top-right corner of the repository page and clicking "Fork".

The next step is to clone your newly forked repository onto your local workspace. This can be done by going to your newly forked repository, which should be at https://github.com/USERNAME/wildfly-s2i.

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 the repository on your computer!

Issues

This project uses Github Issues to manage issues. All issues can be found here.

Setting up your Developer Environment

You will need:

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

Add a remote ref to upstream, for pulling future updates. For example:

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

To build JDK 11, JDK 17 and JDK 21 builder and runtime images look at this : Readme.

To run the behave tests:

cd wildfly-builder-image
cekit test behave

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 title of your pull request and in your commit message.

  3. Please include the link to the GitHub issue you worked on in the description of the pull request.