Skip to content
This repository has been archived by the owner on Feb 21, 2024. It is now read-only.

Latest commit

 

History

History
38 lines (25 loc) · 2.21 KB

CONTRIBUTING.md

File metadata and controls

38 lines (25 loc) · 2.21 KB

Opensource Turbo ⭐

Thanks for taking the time to contribute 💖 The following is a set of guidelines and conventions you must follow to get your contributions accepted and account for.

Please do not create an issue to ask a question, instead contact support in our Discord server.

Contributing

Before contributing in any manner, please read our code of conduct and make sure you follow all the mentioned guidelines!

If you're interested in contributing with bugs or feature requests, either -

  • create a new issue
  • choose the respective issue template (bug report of feature request)
  • follow the template and describe the issue
  • create the issue and wait for a maintainer to review it or you can report it in our Discord server

If you are interested in contributing with code, you need to -

  • find an issue with the help wanted tag
  • comment on the issue and ask for a maintainer to assign you to it
  • once the issue has been assigned, create a fork of this repository's staging branch
  • make your desired changes
  • create a new PR from your fork to Turbo's staging branch (follow the PR template we provide)
  • wait for a maintainer to review your PR

Conventions and Styleguide

We indent our code using 2 spaces. We use the Prettier extension to format our code. We also have a GitHub action to automatically format PRs, we would still recommend downloading Prettier on your preferred editor though. Here's a list of downloads for an editor you may use.

Conclusion

Thanks a lot for reading through! Star this repository, check out our website, join our Discord server and follow us on Twitter! Have a nice day! ✌