Add CONTRIBUTING.md for new contributors#1757
Merged
Merged
Conversation
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a self-contained, newcomer-oriented
CONTRIBUTING.mdat the repository root. GitHub surfaces it automatically on the New Issue / New PR screens.Motivated by a new contributor on WW-5637 who asked for documentation covering the project structure, how the framework is maintained, the development workflow, and the steps to contribute. No such newcomer guide existed (the
struts-site/contributorspages target committers/release managers).Covers: getting help (mailing lists, JIRA), project overview + module map, prerequisites & building (JDK 17,
mvn test -DskipAssembly,-Pjakartaee11), finding work, the fork→branch→PR workflow with theWW-XXXXconventions, private security reporting, and licensing / Code of Conduct.Release/signing/key-setup/IDE-license topics are intentionally out of scope (committer concerns already documented on struts-site).
Documentation only — no code changes.
🤖 Generated with Claude Code