docs: update guestbook contribution process #314
Open
BekahHW wants to merge 2 commits into
Open
Conversation
Update instructions to reflect new JSON-based contribution system that eliminates merge conflicts. Changes: - Replace CLI-based process with JSON file creation - Add clear field-by-field explanations - Include preview command for validation - Update merge conflict section (conflicts now rare) - Add troubleshooting for common JSON errors - Emphasize single-file contribution model Addresses the new contribution workflow in OpenSource-Communities/guestbook Co-authored-by: Cursor <cursoragent@cursor.com>
✅ Deploy Preview for learn-open-source ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Compliance Checks
Thank you for your Pull Request! We have run several checks on this pull request in order to make sure it's suitable for merging into this project. The results are listed in the following section.
Issue Reference
In order to be considered for merging, the pull request description must refer to a specific issue number.
This check is looking for a phrase similar to: "Fixes #XYZ" or "Resolves #XYZ" where XYZ is the issue number that this pull request is meant to address.
Add back the issue creation step as it's important for teaching new contributors about the issue -> PR workflow. Changes: - Add Step 1: Create an Issue with detailed instructions - Include emphasis on noting issue number - Add 'Closes #issue-number' instruction in PR step - Explain why linking issues is important - Renumber all subsequent steps (2-9) This ensures contributors learn the complete workflow: issue creation -> code changes -> PR with proper linking. Co-authored-by: Cursor <cursoragent@cursor.com>
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.
BLOCKER: new process must be merged first
Update instructions to reflect new JSON-based contribution system that eliminates merge conflicts.
Changes:
Addresses the new contribution workflow in OpenSource-Communities/guestbook
Description
Related Issues
Mobile & Desktop Screenshots/Recordings
Steps to QA
[optional] What GIF best describes this PR or how it makes you feel?