Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
88 lines (59 loc) · 3.49 KB

CONTRIBUTING.md

File metadata and controls

88 lines (59 loc) · 3.49 KB

Contributing to WildFly Security

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

Legal

All contributions to this repository are licensed under the Apache License, version 2.0 or later, or, if another license is specified as governing the file or directory being modified, such other license.

All contributions are subject to the Developer Certificate of Origin (DCO). The DCO text is also included verbatim in the dco.txt file in the .github repository of the organization.

Compliance with Laws and Regulations

All contributions must comply with applicable laws and regulations, including U.S. export control and sanctions restrictions. For background, see the Linux Foundation’s guidance: Navigating Global Regulations and Open Source: US OFAC Sanctions.

Forking the Project

To contribute, you will first need to fork the project in the organization.

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/{project_name}.

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!

Setting up your Developer Environment

You will need:

First cd to the directory where you cloned the project (eg: cd https://github.com/wildfly-security/{project_name})

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

git remote add upstream https://github.com/wildfly-security/{project_name}

It is recommended that you use a separate branch for every issue you work on. To keep things straightforward and memorable, you can name each branch using the GitHub issue number. This way, you can have multiple PRs open for different issues.

git checkout -b Issue_9999

To build https://github.com/wildfly-security/{project_name} run:

mvn clean install

To skip the tests, use:

mvn clean install -DskipTests=true

To run only a specific test, use:

mvn clean install -Dtest=TestClassName

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!