ShuriZma
/
project64
mirror of https://github.com/project64/project64.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
project64/.github/CONTRIBUTING.md

11 lines
1.1 KiB
Markdown
Raw Normal View History

General GitHub-related project improvements and updates Added a CONTRIBUTING file to give new contributors an idea of what they can do to help with the project. Also added an issue and pull request template to assist people with providing accurate and detailed bug reports, as well as making pull requests a bit easier to make and also read. I also added a config.yml file to add a "sponsor" button that points to the Project64 "support the project" page on the website for people who want to support the project. I added an EditorConfig file so that no matter what text editor or IDE contributors use, we still have consistency across all contributions. I also added some EOL and charset enforcements as well as the final newline option to enforce our gitattributes file. Speaking of the gitattributes file, I updated it with some new file types that were in the repo. I also added the generic auto normalize (it's the first line). This MAY cause the entire repo to look like it's being changed, but it isn't I promise. If this happens it will be the first and last time unless we change it again. Most of the additions are just (as above) enforcing things we are already doing, like how diffs are handled and such. I also added some future proofing with Linux and Mac-related file types and some other binary files. This PR is still a work-in-progress and is mostly done very late and early into the morning, so be gentle with me. 😄
2021-03-07 11:07:14 +00:00
# Introduction
Add the new README, new support documents, and new changelog (#2258) * Add icon and screenshot * Add support document * Add the new README * Update README.md * Fix screenshot and icon * Try to fix icon a bit * Finally fix logo * Fix screenshot too? * Remove duplicate (oops) * Add note about 64-bit builds * Formatting and punctuation * Overhaul contributing file * Make links relative * Fix support document? * Flesh out the bug issue template a bit and provide some additional info * Split the changelogs, and update formatting * Link to the Android changelog * Make a slightly more accurate changelog * Small fix * Fix some wording * Add icon and screenshot * Add support document * Add the new README * Update README.md * Fix screenshot and icon * Try to fix icon a bit * Finally fix logo * Fix screenshot too? * Remove duplicate (oops) * Add note about 64-bit builds * Formatting and punctuation * Overhaul contributing file * Make links relative * Fix support document? * Flesh out the bug issue template a bit and provide some additional info * Split the changelogs, and update formatting * Link to the Android changelog * Make a slightly more accurate changelog * Small fix * Fix some wording * Add some more TODOs * Add another TODO * Update README.md
2022-08-09 11:13:58 +00:00
First of all, thank you for considering contributing to Project64! Project64 is an open-source project and we love to receive contributions from the community. Contributions by the community help fix bugs, add new features, and improve the project. There are many ways to contribute, from writing and improving the documentation, testing, submitting bug reports and feature requests, or writing code which can be incorporated into Project64 itself.
General GitHub-related project improvements and updates Added a CONTRIBUTING file to give new contributors an idea of what they can do to help with the project. Also added an issue and pull request template to assist people with providing accurate and detailed bug reports, as well as making pull requests a bit easier to make and also read. I also added a config.yml file to add a "sponsor" button that points to the Project64 "support the project" page on the website for people who want to support the project. I added an EditorConfig file so that no matter what text editor or IDE contributors use, we still have consistency across all contributions. I also added some EOL and charset enforcements as well as the final newline option to enforce our gitattributes file. Speaking of the gitattributes file, I updated it with some new file types that were in the repo. I also added the generic auto normalize (it's the first line). This MAY cause the entire repo to look like it's being changed, but it isn't I promise. If this happens it will be the first and last time unless we change it again. Most of the additions are just (as above) enforcing things we are already doing, like how diffs are handled and such. I also added some future proofing with Linux and Mac-related file types and some other binary files. This PR is still a work-in-progress and is mostly done very late and early into the morning, so be gentle with me. 😄
2021-03-07 11:07:14 +00:00
Add the new README, new support documents, and new changelog (#2258) * Add icon and screenshot * Add support document * Add the new README * Update README.md * Fix screenshot and icon * Try to fix icon a bit * Finally fix logo * Fix screenshot too? * Remove duplicate (oops) * Add note about 64-bit builds * Formatting and punctuation * Overhaul contributing file * Make links relative * Fix support document? * Flesh out the bug issue template a bit and provide some additional info * Split the changelogs, and update formatting * Link to the Android changelog * Make a slightly more accurate changelog * Small fix * Fix some wording * Add icon and screenshot * Add support document * Add the new README * Update README.md * Fix screenshot and icon * Try to fix icon a bit * Finally fix logo * Fix screenshot too? * Remove duplicate (oops) * Add note about 64-bit builds * Formatting and punctuation * Overhaul contributing file * Make links relative * Fix support document? * Flesh out the bug issue template a bit and provide some additional info * Split the changelogs, and update formatting * Link to the Android changelog * Make a slightly more accurate changelog * Small fix * Fix some wording * Add some more TODOs * Add another TODO * Update README.md
2022-08-09 11:13:58 +00:00
If you are looking for support or need help, please join the [Discord](https://discord.gg/Cg3zquF)! It's the best way to get your questions answered quickly. Please do not open a GitHub issue without first reading through the [support document](../Docs/SUPPORT.md).
General GitHub-related project improvements and updates Added a CONTRIBUTING file to give new contributors an idea of what they can do to help with the project. Also added an issue and pull request template to assist people with providing accurate and detailed bug reports, as well as making pull requests a bit easier to make and also read. I also added a config.yml file to add a "sponsor" button that points to the Project64 "support the project" page on the website for people who want to support the project. I added an EditorConfig file so that no matter what text editor or IDE contributors use, we still have consistency across all contributions. I also added some EOL and charset enforcements as well as the final newline option to enforce our gitattributes file. Speaking of the gitattributes file, I updated it with some new file types that were in the repo. I also added the generic auto normalize (it's the first line). This MAY cause the entire repo to look like it's being changed, but it isn't I promise. If this happens it will be the first and last time unless we change it again. Most of the additions are just (as above) enforcing things we are already doing, like how diffs are handled and such. I also added some future proofing with Linux and Mac-related file types and some other binary files. This PR is still a work-in-progress and is mostly done very late and early into the morning, so be gentle with me. 😄
2021-03-07 11:07:14 +00:00
Add the new README, new support documents, and new changelog (#2258) * Add icon and screenshot * Add support document * Add the new README * Update README.md * Fix screenshot and icon * Try to fix icon a bit * Finally fix logo * Fix screenshot too? * Remove duplicate (oops) * Add note about 64-bit builds * Formatting and punctuation * Overhaul contributing file * Make links relative * Fix support document? * Flesh out the bug issue template a bit and provide some additional info * Split the changelogs, and update formatting * Link to the Android changelog * Make a slightly more accurate changelog * Small fix * Fix some wording * Add icon and screenshot * Add support document * Add the new README * Update README.md * Fix screenshot and icon * Try to fix icon a bit * Finally fix logo * Fix screenshot too? * Remove duplicate (oops) * Add note about 64-bit builds * Formatting and punctuation * Overhaul contributing file * Make links relative * Fix support document? * Flesh out the bug issue template a bit and provide some additional info * Split the changelogs, and update formatting * Link to the Android changelog * Make a slightly more accurate changelog * Small fix * Fix some wording * Add some more TODOs * Add another TODO * Update README.md
2022-08-09 11:13:58 +00:00
Following these guidelines will help make sure that users and developers alike can work together to achieve the projects goals.
General GitHub-related project improvements and updates Added a CONTRIBUTING file to give new contributors an idea of what they can do to help with the project. Also added an issue and pull request template to assist people with providing accurate and detailed bug reports, as well as making pull requests a bit easier to make and also read. I also added a config.yml file to add a "sponsor" button that points to the Project64 "support the project" page on the website for people who want to support the project. I added an EditorConfig file so that no matter what text editor or IDE contributors use, we still have consistency across all contributions. I also added some EOL and charset enforcements as well as the final newline option to enforce our gitattributes file. Speaking of the gitattributes file, I updated it with some new file types that were in the repo. I also added the generic auto normalize (it's the first line). This MAY cause the entire repo to look like it's being changed, but it isn't I promise. If this happens it will be the first and last time unless we change it again. Most of the additions are just (as above) enforcing things we are already doing, like how diffs are handled and such. I also added some future proofing with Linux and Mac-related file types and some other binary files. This PR is still a work-in-progress and is mostly done very late and early into the morning, so be gentle with me. 😄
2021-03-07 11:07:14 +00:00
Add the new README, new support documents, and new changelog (#2258) * Add icon and screenshot * Add support document * Add the new README * Update README.md * Fix screenshot and icon * Try to fix icon a bit * Finally fix logo * Fix screenshot too? * Remove duplicate (oops) * Add note about 64-bit builds * Formatting and punctuation * Overhaul contributing file * Make links relative * Fix support document? * Flesh out the bug issue template a bit and provide some additional info * Split the changelogs, and update formatting * Link to the Android changelog * Make a slightly more accurate changelog * Small fix * Fix some wording * Add icon and screenshot * Add support document * Add the new README * Update README.md * Fix screenshot and icon * Try to fix icon a bit * Finally fix logo * Fix screenshot too? * Remove duplicate (oops) * Add note about 64-bit builds * Formatting and punctuation * Overhaul contributing file * Make links relative * Fix support document? * Flesh out the bug issue template a bit and provide some additional info * Split the changelogs, and update formatting * Link to the Android changelog * Make a slightly more accurate changelog * Small fix * Fix some wording * Add some more TODOs * Add another TODO * Update README.md
2022-08-09 11:13:58 +00:00
Please do NOT post any copyrighted materials. This includes (but is not limited to) ROMs, ROM hacks, IPL and firmware files, etc.
Some repo improvements and small fixes (#2207) * Enforce a standard issue template This will enforce a standard issue template, and will force the user to make sure they are creating the issue with all of the info the developers and contributors need to help the user. Also updates the README to be less confusing and also a bit more broad in some cases. * Update the issue template for bugs * Add a checkbox for default plugins * Add input plugins to the list * Add a reminder in the CONTRIBUTING file * Add a small improvement to the README * Update BUG.yml with some formatting and text improvements * Switch to YAML for the feature request template as well * Remove old Markdown templates * Fix placeholder on line 30 * Fix assignees * Fix assignees part 2 * Fix assignees part 3 * Fix spacing * Finally fix formatting (YAML is picky) * Fix it part 11 thousand or something * Finally fixed maybe sort of kinda * Update BUG.yml * Fixed some weirdness * Fix required maybe * Finally fixed perhaps?
2022-03-09 06:41:57 +00:00
Add the new README, new support documents, and new changelog (#2258) * Add icon and screenshot * Add support document * Add the new README * Update README.md * Fix screenshot and icon * Try to fix icon a bit * Finally fix logo * Fix screenshot too? * Remove duplicate (oops) * Add note about 64-bit builds * Formatting and punctuation * Overhaul contributing file * Make links relative * Fix support document? * Flesh out the bug issue template a bit and provide some additional info * Split the changelogs, and update formatting * Link to the Android changelog * Make a slightly more accurate changelog * Small fix * Fix some wording * Add icon and screenshot * Add support document * Add the new README * Update README.md * Fix screenshot and icon * Try to fix icon a bit * Finally fix logo * Fix screenshot too? * Remove duplicate (oops) * Add note about 64-bit builds * Formatting and punctuation * Overhaul contributing file * Make links relative * Fix support document? * Flesh out the bug issue template a bit and provide some additional info * Split the changelogs, and update formatting * Link to the Android changelog * Make a slightly more accurate changelog * Small fix * Fix some wording * Add some more TODOs * Add another TODO * Update README.md
2022-08-09 11:13:58 +00:00
Save states and game saves do not fall under this category, so please post them if they are applicable to your issue!