Add more 'how to contribute' documentation #58
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
There was a problem hiding this comment.
Pull Request Overview
This PR expands the README to provide comprehensive contribution guidelines for the LASP developer guide project. The update transforms a minimal README into a detailed contributor guide that explains project structure, formatting standards, and workflow procedures.
- Added detailed sections on Markdown usage, project organization, and formatting consistency
- Included information about content scope limitations and security considerations
- Added instructions for local documentation building and git workflow
README.md
Outdated
| * Avoid sharing opinions about topics without supporting facts | ||
| * Stick to third-person language and avoid using first-person | ||
| * Avoid jargon, acronyms, or abbreviations unless they are defined | ||
| * Keep sentences and paragraphs concise—break up long blocks of text |
Collaborator
There was a problem hiding this comment.
Is concise-break intended to be hyphenated as a compound word or should there be spaces around the hyphen to break up the two statements?
README.md
Outdated
| * Stick to third-person language and avoid using first-person | ||
| * Avoid jargon, acronyms, or abbreviations unless they are defined | ||
| * Keep sentences and paragraphs concise—break up long blocks of text | ||
| * Follow a consistent capitalization style for headings, code terms, proper nouns, etc |
Collaborator
There was a problem hiding this comment.
Add a period after etc
vmartinez-cu
approved these changes
Aug 12, 2025
Collaborator
vmartinez-cu
left a comment
vmartinez-cu
left a comment
There was a problem hiding this comment.
I just had a couple minor comments, but otherwise it looks great! Thanks for adding these updates
bourque
added a commit
that referenced
this pull request
Sep 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 expands the README to include more details on how to contribute to this project.
Closes #19