You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-[FAQ for New Contributors](#faq-for-new-contributors)
11
15
-[Community](#community)
12
16
13
17
@@ -85,8 +89,18 @@ Note: Some tests will fail if `localhost` is not listed first in `/etc/hosts` fi
85
89
86
90
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/).
87
91
92
+
88
93
## Contributing Guidelines
89
94
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
90
104
When submitting a PR, please keep the following guidelines in mind:
91
105
92
106
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:
97
111
98
112
For an example of a properly formatted PR, take a look at https://github.com/wildfly-security/wildfly-elytron/pull/1532
99
113
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
+
100
121
## Code Reviews
101
122
102
123
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
110
131
merge the maintenance branch to the upstream branch to ensure changes are kept in sync.
111
132
112
133
## 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