Outline proposed project objective and requirements #1
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
swissspidy
approved these changes
Jun 18, 2025
swissspidy
reviewed
Jun 18, 2025
| @@ -0,0 +1,101 @@ | |||
| # Requirements | |||
There was a problem hiding this comment.
Nit: could also list some constraints such as PHP version requirements
There was a problem hiding this comment.
I'd like for this to be only focused on functional requirements for the project, so that ideally it can be evergreen. Just clarified that in the description.
You raise an important point though, we also need to define a few technical requirements like PHP version support. I just opened #3 for that.
felixarntz
added
[Type] Developer Documentation
Jameswlepage
approved these changes
Jun 19, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds a
REQUIREMENTS.md, outlining the overall objective for this project, as well as its key requirements. For easier consumption as Markdown, see the file in the branch.It also adds a
GLOSSARY.mdwith common terms, which can be helpful to align communication and discussion.