Docs/add readme instructions#244
Merged
jbampton merged 3 commits intoNextCommunity:mainfrom Jan 26, 2026
Merged
Conversation
- Add complete project overview and description - Include step-by-step guide for adding yourself via PR - Document YAML file format with required/optional fields - Provide real-world examples of user profiles - Add local development setup instructions - Include troubleshooting section and FAQ - Document contribution guidelines and CI/CD process Fixes NextCommunity#213
jbampton
approved these changes
Jan 26, 2026
Member
jbampton
left a comment
jbampton
left a comment
There was a problem hiding this comment.
Awesome work thanks so much !! 🏂
jbampton
added
documentation
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
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.
Fixes #213
This PR adds a comprehensive README.md file to the repository with clear, step-by-step instructions for contributors to add themselves to the NextCommunity developer directory. The README includes a complete project overview, detailed documentation of the YAML file format with real examples, a beginner-friendly PR submission guide, local development setup instructions, and a troubleshooting section. This will significantly reduce confusion for new contributors and streamline the contribution process by providing all necessary information in one place.