Project setup, documentation and pull request template

[nc1z]

Description

Cleanup the repository and provided README and pull request templates.

Why is it needed?

This makes the open source contribution experience much better, and makes the repository look more professional. This is a good start to streamline contribution workflows.

Screenshot or GIFs (if applicable)

If the changes include visual modifications, include screenshots or GIFs to demonstrate the before and after effects.

Testing

Describe the testing strategy employed for this PR, including any manual or automated tests conducted. Specify the testing environment and provide clear instructions for reviewers on how to reproduce the tests, if applicable.

Related issue(s)/PR(s)

Let us know if this is related to any issue/pull request

Additional Notes

Include any additional information or context that may be helpful for reviewers.

[vercel[bot]]

@nc1z is attempting to deploy a commit to the joschan21's projects Team on Vercel.

A member of the Team first needs to authorize it.

[NatanaelBorges]

I don't think adding .DS_Store to the .gitignore file may seem like a simple solution to avoid including this file in the repository. However, there are a few reasons why this may not be the best practice:

• Collaboration: Excluding .DS_Store files from version control ensures that collaborators working on different operating systems do not inadvertently include system-specific files in the repository. This promotes collaboration by maintaining a consistent project structure among all contributors, regardless of their operating system preferences.

• Cleanliness: Keeping the .DS_Store file out of version control helps maintain a clean and organized repository. System-specific files like .DS_Store are not relevant to the codebase. Deleting it ensures that the repository contains only files essential to the project, making it easier to navigate and manage.

In summary, while adding .DS_Store to the .gitignore file can provide a quick solution in a Git-based workflow, it is beneficial to adopt practices that address the problem more comprehensively.

[uncenter]

I don't think adding .DS_Store to the .gitignore file may seem like a simple solution to avoid including this file in the repository. However, there are a few reasons why this may not be the best practice:

• Collaboration: Excluding .DS_Store files from version control ensures that collaborators working on different operating systems do not inadvertently include system-specific files in the repository. This promotes collaboration by maintaining a consistent project structure among all contributors, regardless of their operating system preferences.
• Cleanliness: Keeping the .DS_Store file out of version control helps maintain a clean and organized repository. System-specific files like .DS_Store are not relevant to the codebase. Deleting it ensures that the repository contains only files essential to the project, making it easier to navigate and manage.

In summary, while adding .DS_Store to the .gitignore file can provide a quick solution in a Git-based workflow, it is beneficial to adopt practices that address the problem more comprehensively.

ChatGPT much?

[NatanaelBorges]

I don't think adding .DS_Store to the .gitignore file may seem like a simple solution to avoid including this file in the repository. However, there are a few reasons why this may not be the best practice:

• Collaboration: Excluding .DS_Store files from version control ensures that collaborators working on different operating systems do not inadvertently include system-specific files in the repository. This promotes collaboration by maintaining a consistent project structure among all contributors, regardless of their operating system preferences.
• Cleanliness: Keeping the .DS_Store file out of version control helps maintain a clean and organized repository. System-specific files like .DS_Store are not relevant to the codebase. Deleting it ensures that the repository contains only files essential to the project, making it easier to navigate and manage.

In summary, while adding .DS_Store to the .gitignore file can provide a quick solution in a Git-based workflow, it is beneficial to adopt practices that address the problem more comprehensively.

ChatGPT much?

Not much, but just to try to make my point of view clear, I believe this isn't the case. What would be your opinion on this PR? It's of utmost relevance to everyone, and I would genuinely appreciate your opinion as they would help me improve further.