Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOCS] Contributor's guide #4133

Merged
merged 1 commit into from
Feb 14, 2025
Merged

[DOCS] Contributor's guide #4133

merged 1 commit into from
Feb 14, 2025

Conversation

AbnormalPoof
Copy link
Collaborator

@AbnormalPoof AbnormalPoof commented Feb 12, 2025 •
edited
Loading

Closes #2362

This is a general contributor's guide made in collaboration with @Hundrec, serving as a resource for people wanting to contribute to the repository!

@github-actions github-actions bot added status: pending triage Awaiting review. pr: documentation PR modifies documentation or README files. size: large A large pull request with more than 100 changes. labels Feb 12, 2025
@AbnormalPoof AbnormalPoof added type: documentation Involves improvements or additions to documentation. topic: help wanted Ideal for work by outside contributors. labels Feb 12, 2025
@AbnormalPoof AbnormalPoof force-pushed the docs/contributors-guide branch from 9046e08 to 7191d87 Compare February 12, 2025 20:11
@EliteMasterEric
Copy link
Member

This looks great so far! Going to leave this up as a draft for a while so we can get lots of eyes on it before it's approved.

@KoloInDaCrib
Copy link
Contributor

Great work, thank you both! I have no criticism besides a small suggestion - perhaps it would be nice if there was a part about squashing commits in a PR into one, if a lot of them are provided. Other than that, really cool!

@Hundrec
Copy link
Collaborator

Hundrec commented Feb 12, 2025

Thanks Kolo, great suggestion! We'll be sure to include that soon :)

NotHyper-474
NotHyper-474 reviewed Feb 12, 2025
View reviewed changes
@AbnormalPoof AbnormalPoof added status: needs revision Cannot be approved because it is awaiting some work by the contributor. and removed status: pending triage Awaiting review. labels Feb 12, 2025
@Lasercar
Copy link
Contributor

Lasercar commented Feb 13, 2025 •
edited
Loading

Looks good to me! This would of definitely helped for those first few PRs of mine.

(ah, so that's how you review stuff... I didn't realise I still hadn't 'finished' the review)

Lasercar
Lasercar reviewed Feb 13, 2025
View reviewed changes
@Hundrec
Copy link
Collaborator

Hundrec commented Feb 13, 2025

Thanks for the comments, Lasercar!

I'll review these later, but I can assure you I've already PR'd the first change you mentioned.

@AbnormalPoof
Copy link
Collaborator Author

@Lasercar Looking through your review comments now...

@Hundrec Hundrec added status: reviewing internally Under consideration and testing. and removed status: needs revision Cannot be approved because it is awaiting some work by the contributor. labels Feb 13, 2025
@AbnormalPoof AbnormalPoof changed the title [Request For Comment] Contributor's guide [DOCS] Contributor's guide Feb 13, 2025
@AbnormalPoof AbnormalPoof marked this pull request as ready for review February 13, 2025 23:47
@AbnormalPoof @Hundrec
Contributor's guide
a98b551 
Co-authored-by: Hundrec <[email protected]>
Co-authored-by: Abnormal <[email protected]>
@AbnormalPoof AbnormalPoof force-pushed the docs/contributors-guide branch from e11f017 to a98b551 Compare February 13, 2025 23:49
@AbnormalPoof AbnormalPoof removed the topic: help wanted Ideal for work by outside contributors. label Feb 13, 2025
@AbnormalPoof AbnormalPoof requested review from EliteMasterEric and removed request for Lasercar February 13, 2025 23:54
@EliteMasterEric EliteMasterEric removed the status: reviewing internally Under consideration and testing. label Feb 14, 2025
@EliteMasterEric EliteMasterEric added the status: accepted PR was approved for contribution. If it's not already merged, it may be merged on a private branch. label Feb 14, 2025
@EliteMasterEric EliteMasterEric self-assigned this Feb 14, 2025
@EliteMasterEric EliteMasterEric added this to the 0.6.0 (Pit Stop 2) milestone Feb 14, 2025
@EliteMasterEric EliteMasterEric merged commit 943c387 into FunkinCrew:main Feb 14, 2025
5 checks passed
@AbnormalPoof AbnormalPoof deleted the docs/contributors-guide branch February 14, 2025 00:02
@AbnormalPoof AbnormalPoof mentioned this pull request Feb 14, 2025
Merged
@AbnormalPoof AbnormalPoof removed the request for review from EliteMasterEric February 14, 2025 00:25
Lasercar
Lasercar reviewed Feb 14, 2025
View reviewed changes
Copy link
Contributor

@Lasercar Lasercar left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry about the wait for the review, I only just got back from work.

Looks great!

When I mentioned providing an example for the documentation PR I thought you'd add a link to a real documentation PR or two, not provide an example like that! It works either way though.

Also, I don't have an option to approve? That's a bit weird. I guess it's already been merged and everything.

@EliteMasterEric EliteMasterEric removed their assignment Feb 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Lasercar Lasercar Lasercar left review comments

@NotHyper-474 NotHyper-474 NotHyper-474 approved these changes

@Hundrec Hundrec Hundrec approved these changes

Assignees
No one assigned
Labels
pr: documentation PR modifies documentation or README files. size: large A large pull request with more than 100 changes. status: accepted PR was approved for contribution. If it's not already merged, it may be merged on a private branch. type: documentation Involves improvements or additions to documentation.
Projects
None yet
Milestone
0.6.0 (Pit Stop 2)
Development

Successfully merging this pull request may close these issues.

Add a Contributing guide file
6 participants
@AbnormalPoof @EliteMasterEric @KoloInDaCrib @Hundrec @Lasercar @NotHyper-474