search

pingdotgg / uploadthing

File uploads for modern web devs
https://uploadthing.com
MIT License
4.16k stars 306 forks source link

docs: Missing Contributing File #893

Closed Bashamega closed 2 months ago

Bashamega commented 3 months ago

Area of Improvement

Hello:)

The contributing guide file is missing. It is nice to have one.

Link to related docs

No response

Additional information

No response

👨‍👧‍👦 Contributing

juliusmarminge commented 2 months ago

https://github.com/pingdotgg/uploadthing#contributing

Bashamega commented 2 months ago

A separate CONTRIBUTING.md file is better. Here's why:

  1. A separate file for contributing guidelines helps organize information better. The README.md can describe the project, its use, and features. The CONTRIBUTING.md can give detailed guidelines on how to contribute.
  2. GitHub recognizes the CONTRIBUTING.md file. It gives a direct link to it when someone creates a new issue or pull request. This makes it more likely for contributors to see and read the guidelines.
  3. A dedicated file lets you include detailed information without making the README.md messy. You can cover many aspects like coding standards how to set up the development environment, and how to submit pull requests.
  4. A clear guide for contributors can inspire more people to help out. It gives step-by-step instructions and makes the whole process less scary.

Still, you can add a short part in your README.md that links to the CONTRIBUTING.md file. This way, people who start with the README.md will know about the rules for contributing.