-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
WFNC-81 Add CONTRIBUTING.txt/md/adoc file to this project
- Loading branch information
Showing
1 changed file
with
84 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
# Contributing to WildFly Naming Client | ||
|
||
Welcome to the WildFly Naming Client project! We welcome contributions from the community. This guide will walk you through the steps for getting started on our project. | ||
|
||
- [Forking the Project](#forking-the-project) | ||
- [Issues](#issues) | ||
- [Good First Issues](#good-first-issues) | ||
- [Setting up your Developer Environment](#setting-up-your-developer-environment) | ||
- [Contributing Guidelines](#contributing-guidelines) | ||
- [Community](#community) | ||
|
||
## Forking the Project | ||
To contribute, you will first need to fork the [wildfly-naming-client](https://github.com/wildfly/wildfly-naming-client) repository. | ||
|
||
This can be done by looking in the top-right corner of the repository page and clicking "Fork". | ||
![fork](assets/images/fork.jpg) | ||
|
||
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-naming-client`. | ||
|
||
Then, there will be a green button that says "Code". Click on that and copy the URL. | ||
|
||
![clone](assets/images/clone.png) | ||
|
||
Then, in your terminal, paste the following command: | ||
```bash | ||
git clone [URL] | ||
``` | ||
Be sure to replace [URL] with the URL that you copied. | ||
|
||
Now you have the repository on your computer! | ||
|
||
### Good First Issues | ||
Want to contribute to the WildFly Naming client project but aren't quite sure where to start? Check out our issues with the `good-first-issue` label. | ||
|
||
Once you have selected an issue you'd like to work on, make sure it's not already assigned to someone else. To assign an issue to yourself, simply click on "Start Progress". This will automatically assign the issue to you. | ||
|
||
![jira](assets/images/jira_start_progress.png) | ||
|
||
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 JIRA issue number. This way, you can have multiple PRs open for different issues. For example, if you were working on [WFNC-84](https://issues.redhat.com/browse/WFNC-84), you could use WFNC-84 as your branch name. | ||
|
||
## Setting up your Developer Environment | ||
You will need: | ||
|
||
* JDK | ||
* Git | ||
* Maven | ||
* An [IDE](https://en.wikipedia.org/wiki/Comparison_of_integrated_development_environments#Java) | ||
(e.g., [IntelliJ IDEA](https://www.jetbrains.com/idea/download/), [Eclipse](https://www.eclipse.org/downloads/), etc.) | ||
|
||
|
||
First `cd` to the directory where you cloned the project | ||
|
||
Add a remote ref to upstream, for pulling future updates. | ||
For example: | ||
|
||
``` | ||
git remote add upstream https://github.com/wildfly/wildfly-naming-client | ||
``` | ||
To build `wildfly-naming-client` run: | ||
```bash | ||
mvn clean install | ||
``` | ||
|
||
To skip the tests, use: | ||
|
||
```bash | ||
mvn clean install -DskipTests=true | ||
``` | ||
|
||
To run only a specific test, use: | ||
|
||
```bash | ||
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 squashing 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 JIRA issue you worked on in the title of your pull request and in your commit message. For example, for [WFNC-84](https://issues.redhat.com/browse/WFNC-84), the PR title and commit message should be `[WFNC-84] Consider adopting a CODEOWNERS file`. | ||
|
||
3. Please include the link to the JIRA issue you worked on in the description of the pull request. For example, if your PR adds a fix for [WFNC-84](https://issues.redhat.com/browse/WFNC-84), the PR description should contain a link to https://issues.redhat.com/browse/WFNC-84. |