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. 😄
This commit is contained in:
Derek "Turtle" Roe 2021-03-07 05:07:14 -06:00
parent 93b35cdf28
commit 1526da8d48
7 changed files with 147 additions and 13 deletions

7
.editorconfig Normal file
View File

@ -0,0 +1,7 @@
root = true
[*]
end_of_line = crlf
charset = utf-8
trim_trailing_whitespace = false
insert_final_newline = true

112
.gitattributes vendored
View File

@ -1,16 +1,102 @@
* text=auto
# C/C++ source files
*.c text diff=c
*.cc text diff=cpp
*.cxx text diff=cpp
*.cpp text diff=cpp
*.c++ text diff=cpp
*.hpp text diff=cpp
*.h text diff=c
*.h++ text diff=cpp
*.hh text diff=cpp
# Java source files
*.java text diff=java
*.gradle text diff=java
*.gradle.kts text diff=java
# Web source files
*.css text diff=css
*.htm text diff=html
*.html text diff=html
*.js text
*.jsp text
*.jspf text
*.jspx text
*.properties text
*.xml text
# Inno setup files
*.isl text
*.iss text
# All files that are binary and should not be normalized
# Images
*.png binary
*.jpg binary
*.psd binary
*.gif binary
*.bmp binary
*.ico binary
*.cur binary
# Binary Java files
# Binary data
*.exe binary
*.dll binary
*.e32 binary
*.lib binary
*.class binary
*.ear binary
*.jar binary
*.war binary
*.jks binary
# Compiled object files
*.slo binary
*.lo binary
*.o binary
*.obj binary
# Precompiled headers
*.gch binary
*.pch binary
# Compiled dynamic libraries
*.so binary
*.dylib binary
# Compiled Static libraries
*.lai binary
*.la binary
*.a binary
*.lib binary
# Binary data and executables
*.exe binary
*.out binary
*.app binary
*.dll binary
*.e32 binary
# Archives
*.7z binary
*.gz binary
*.tar binary
*.tgz binary
*.zip binary
*.rar binary
*.cab binary
# Images
*.png binary
*.jpg binary
*.jpeg binary
*.psd binary
*.gif binary
*.bmp binary
*.ico binary
*.cur binary
*.svg binary
*.tif binary
*.tiff binary

9
.github/CONTRIBUTING.md vendored Normal file
View File

@ -0,0 +1,9 @@
# Introduction
>First of all, thank you for considering contributing to Project64! Project64 is an open-source project and contributions by the community help fix bugs, add new features, and improve the project.
>Following these guidelines will help make sure that users and developers alike can work together to achieve the projects goals.
>Project64 is an open-source project and we love to receive contributions from the community. 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.
>Please don't use the issue tracker for support questions. Please join the Discord so the community can help with your issue!

1
.github/FUNDING.yml vendored Normal file
View File

@ -0,0 +1 @@
custom: "https://pj64-emu.com/support-project64.html"

19
.github/ISSUE_TEMPLATE.md vendored Normal file
View File

@ -0,0 +1,19 @@
## Expected behavior
## Actual behavior
## Steps to reproduce the problem
1.
1.
1.
1.
1.
## Specifications
- Windows version:
- Project64 version:
- Plugins used:

5
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Project64 Community Support
url: https://discord.gg/Cg3zquF
about: Please ask and answer questions on our Discord!

7
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@ -0,0 +1,7 @@
Fixes #
## Proposed Changes
-
-
-