Skip to content

Commit 16ac561

Browse files
luck3ypedro-hos
authored andcommitted
[ELY-2455]: Add a "FAQ for New Contributors" section to the CONTRIBUTING.md file (rebased) from pr2091"
1 parent 0dc6c8a commit 16ac561

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ Welcome to the WildFly Elytron project! We welcome contributions from the commun
88
- [Good First Issues](#good-first-issues)
99
- [Setting up your Developer Environment](#setting-up-your-developer-environment)
1010
- [Contributing Guidelines](#contributing-guidelines)
11+
- [Testing](#testing)
12+
- [Pull Request Process](#pull-request-process)
13+
- [Documentation](#documentation)
14+
- [FAQ for New Contributors](#faq-for-new-contributors)
1115
- [Community](#community)
1216

1317

@@ -85,8 +89,18 @@ Note: Some tests will fail if `localhost` is not listed first in `/etc/hosts` fi
8589

8690
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/).
8791

92+
8893
## Contributing Guidelines
8994

95+
### Testing
96+
Ensure that your changes are thoroughly tested before submitting a pull request. Follow these testing guidelines:
97+
98+
- Run the existing unit tests using Maven: `mvn clean test`
99+
- Include new unit tests for your code changes.
100+
101+
If applicable, provide instructions on how to run integration tests or any additional testing procedures.
102+
103+
### Pull Request Process
90104
When submitting a PR, please keep the following guidelines in mind:
91105

92106
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:
97111

98112
For an example of a properly formatted PR, take a look at https://github.com/wildfly-security/wildfly-elytron/pull/1532
99113

114+
### Documentation
115+
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.
116+
Community documentation can be found in the [wildfly repository](https://github.com/wildfly/wildfly/tree/main/docs)
117+
118+
## FAQ for New Contributors
119+
Check out our [Frequently Asked Questions](https://fjuma.github.io/wildfly-elytron/blog/frequently-asked-questions-new-contributors/) for New Contributors.
120+
100121
## Code Reviews
101122

102123
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
110131
merge the maintenance branch to the upstream branch to ensure changes are kept in sync.
111132

112133
## Community
113-
For more information on how to get involved with WildFly Elytron, check out our [community](https://wildfly-security.github.io/wildfly-elytron/community/) page.
134+
For more information on how to get involved with WildFly Elytron, check out our [community](https://wildfly-security.github.io/wildfly-elytron/community/) page.

0 commit comments

Comments
 (0)