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.

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

Add a Contributing guide file #2362

Open
NotHyper-474 opened this issue May 8, 2024 · 1 comment
Open

Add a Contributing guide file #2362

NotHyper-474 opened this issue May 8, 2024 · 1 comment
Labels
status: pending triage Awaiting review. type: documentation Involves improvements or additions to documentation.

Comments

@NotHyper-474
Copy link
Contributor

NotHyper-474 commented May 8, 2024

In the Contributing section, clicking the hyperlink will attempt to open a missing 'CONTRIBUTORS.MD' file

Please make one, it could, for instance, explain that you should make code contributions (via pull requests) basing on the main branch if it's a documentation change and develop if it's a code change.

Here's more or less how I think this file would go:

Thanks for the initiative to contribute to Friday Night Funkin'! You can help by either:
* Creating an issue report if you spot a bug or experience a crash, but make sure to see if that was not already reported before to not make duplicates!
* Making a pull request with either documentation changes or code contributions! Please, as with issue reports, search if another pull request didn't do that already! Read more details on how to contribute with code contributions below.

Footnote: Please make sure you're also on the right repository, if you want to report something for an engine, do it on their repository instead!

### Contributing with code or documentation 
If you're making changes to documentation, which includes any file that ends with `.md`, you should base your changes on the `main` branch.  
Otherwise, you should base it on the `develop` branch.

If you're doing changes on either the `assets` or `art` submodules, please make the pull request over their respective repositories.
@NotHyper-474 NotHyper-474 changed the title README has hyperlink to missing file File missing from repository May 8, 2024
@NotHyper-474 NotHyper-474 changed the title File missing from repository Contributing Guide file missing from repository May 8, 2024
@ninjamuffin99 ninjamuffin99 added type: documentation Involves improvements or additions to documentation. Improvement labels May 30, 2024 — with Linear
@ninjamuffin99 ninjamuffin99 changed the title Contributing Guide file missing from repository Add CONTRIBUTORS.md file May 30, 2024
@Hundrec
Copy link
Collaborator

Hundrec commented Oct 16, 2024

If Eric and Mr. Cameron Muffin have a rough idea of what should be in the Contributor's Guide, please let us know!

@AbnormalPoof AbnormalPoof added the status: pending triage Awaiting review. label Jan 22, 2025
@AbnormalPoof AbnormalPoof marked this as a duplicate of #2404 Jan 22, 2025
@NotHyper-474 NotHyper-474 changed the title Add CONTRIBUTORS.md file Add a Contributing guide file Jan 23, 2025
@Hundrec Hundrec marked this as a duplicate of #2415 Jan 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: pending triage Awaiting review. type: documentation Involves improvements or additions to documentation.
Projects
None yet
Development

No branches or pull requests

5 participants