diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b4979fa4e6..5f45d5cc34 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,6 +8,10 @@ Welcome to the WildFly Elytron project! We welcome contributions from the commun - [Good First Issues](#good-first-issues) - [Setting up your Developer Environment](#setting-up-your-developer-environment) - [Contributing Guidelines](#contributing-guidelines) + - [Testing](#testing) + - [Pull Request Process](#pull-request-process) + - [Documentation](#documentation) +- [FAQ for New Contributors](#faq-for-new-contributors) - [Community](#community) @@ -85,8 +89,18 @@ Note: Some tests will fail if `localhost` is not listed first in `/etc/hosts` fi For more information, including details on how WildFly Elytron is integrated in WildFly Core and WildFly, check out our [developer guide](https://wildfly-security.github.io/wildfly-elytron/getting-started-for-developers/). + ## Contributing Guidelines +### Testing +Ensure that your changes are thoroughly tested before submitting a pull request. Follow these testing guidelines: + +- Run the existing unit tests using Maven: `mvn clean test` +- Include new unit tests for your code changes. + +If applicable, provide instructions on how to run integration tests or any additional testing procedures. + +### Pull Request Process 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! @@ -97,6 +111,13 @@ When submitting a PR, please keep the following guidelines in mind: For an example of a properly formatted PR, take a look at https://github.com/wildfly-security/wildfly-elytron/pull/1532 +### Documentation +Contributors are encouraged to keep documentation up-to-date along with code changes. If your changes impact user-facing features, update the relevant documentation files in directory. +Community documentation can be found in the [wildfly repository](https://github.com/wildfly/wildfly/tree/main/docs) + +## FAQ for New Contributors +Check out our [Frequently Asked Questions](https://fjuma.github.io/wildfly-elytron/blog/frequently-asked-questions-new-contributors/) for New Contributors. + ## Code Reviews All submissions, including submissions by project members, need to be reviewed by at least two WildFly Elytron committers before being merged. @@ -110,4 +131,4 @@ your PR directly against the relevant maintenance branch. Once a fix for a maint merge the maintenance branch to the upstream branch to ensure changes are kept in sync. ## Community -For more information on how to get involved with WildFly Elytron, check out our [community](https://wildfly-security.github.io/wildfly-elytron/community/) page. +For more information on how to get involved with WildFly Elytron, check out our [community](https://wildfly-security.github.io/wildfly-elytron/community/) page. \ No newline at end of file