Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[ELY-2455]: Add a "FAQ for New Contributors" section to the CONTRIBUTING.md file (rebased from pr2091)" #2200

Merged
merged 1 commit into from
Oct 2, 2024
Merged

[ELY-2455]: Add a "FAQ for New Contributors" section to the CONTRIBUTING.md file (rebased from pr2091)" #2200

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)


Expand Down Expand Up @@ -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!
Expand All @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link should be https://wildfly-security.github.io/wildfly-elytron/blog/frequently-asked-questions-new-contributors/

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm going to merge this one and create a good-first-issue for updating the link.


## Code Reviews

All submissions, including submissions by project members, need to be reviewed by at least two WildFly Elytron committers before being merged.
Expand All @@ -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.
Loading