Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 1.67 KB

contribution-guide.md

File metadata and controls

41 lines (29 loc) · 1.67 KB
Raw

Contributions to uses.dev

Steps

  1. Fork this repo
  2. Add yourself to /src/data.js
  3. When requesting a PR please read carefully.
  4. Be nice to maintainers

PR Guidelines

  • Should be updated with the latest main or master branch.
  • PR Title should be the name or handle of the person being added or update being made.
    • A bad PR title update data.js
    • A good PR Title Adding Blake Campbell

What's a Uses Page?

A /uses page lists a developer's setup, gear, software, and configs (what they use). It's a great reference for those looking to add to their library of tools or reconfigure ones they already use.

The URL MUST follow the format of use|uses|using|setup|environment at the end.

What Should I Include?

Include the hardware you use, such as your computer and other related equipment. Include your preferred terminal, text editors, tools, frameworks, and other related software you use. If you can, include configurations for software (such as fonts and themes). The more you have on your /uses page, the more interesting it'll be to those who view it - just keep it on-topic!

Adding Yourself

  • Ensure you are linking to a /uses page, not just your website
  • Ensure your data is formatted like other entries
  • Do not add yourself to the end of the array (add yourself somewhere random instead)
  • Ensure this PR has a title in the following format
    • ✅ Add Your Name
    • ✅ Add @twitterusername
    • ❌ Add myself
    • ❌ Adding myself!
    • ❌ Add Your Name @twitter @github

Code Modifications

  • Ensure the code submitted is formatted similarly to existing code
  • Ensure variable, method, function, and component names are clear and concise