Welcome to the JBoss EJB 3 Extension API project! We welcome contributions from the community. This guide will walk you through the steps for getting started on our project.
- Legal
- Forking the Project
- Issues
- Setting up your Developer Environment
- Contributing Guidelines
- Community
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 root directory of the repository.
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.
To contribute, you will first need to fork the jboss-ejb3-ext-api 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/jboss-ejb3-ext-api.
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!
The JBoss EJB 3 Extension API project uses GitHub Issues to manage issues. All issues can be found here.
To create a new issue, comment on an existing issue, or assign an issue to yourself, you'll need to first create a GitHub account.
Once you have selected an issue you'd like to work on, make sure it's not already assigned to someone else. Before beginning work on an issue, it's good to start a thread in the wildfly-developers channel in Zulip to let others know what you'll be doing.
Want to contribute to the JBoss EJB 3 Extension API project but aren't quite sure where to start? Look for issues with the good first issue label. These are a triaged set of issues that are great for getting started on our project. These can be found here.
You will need:
- JDK
- Git
- Maven
- An IDE (e.g., IntelliJ IDEA, Eclipse, VS Code, etc.)
First cd to the directory where you cloned the project (eg: cd jboss-ejb3-ext-api)
Add a remote ref to upstream, for pulling future updates. For example:
git remote add upstream https://github.com/wildfly/jboss-ejb3-ext-api
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.
git checkout -b Issue_9999To build jboss-ejb3-ext-api run:
mvn clean installTo skip the tests, use:
mvn clean install -DskipTests=trueTo run only a specific test, use:
mvn clean install -Dtest=TestClassNameWhen submitting a PR, please keep the following guidelines in mind:
-
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!
-
Please include the GitHub issue you worked on in the title of your pull request and in your commit message. For example, for issue 999, the PR title and commit message should be
[Issue_999] Create a testcase which verifies behaviour of the foo. -
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 999, the PR description should contain a link to https://github.com/wildfly/jboss-ejb3-ext-api/issues/999.