Skip to content

Latest commit

 

History

History
41 lines (32 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

41 lines (32 loc) · 1.63 KB
Raw

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued, no matter if it's a bug report 🐛, a feature request 💡, or a Pull Request 🚀.

  • ❓ I have a question: Open a Discussion/Issue
  • 🐛 I found a bug: Open an Issue
  • 💡 I have an idea: Open a Discussion/Issue
  • 💻 I want to code: See below

If you like the project, but just don't have time to contribute, that's OK too! You can also star the project ⭐, rave about it online 💬, or add a link to us 🔗 in your project's readme.

⚠️ You must never report security 🔒 related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to [email protected].

Writing code

  1. 🔀 Fork the repo
  2. 💻 Open the repo in your editor
  3. 👨‍💻 Add your changes to your workspace
  4. ✨ Run the tests to make sure everything works
  5. 🔖 Commit & push your changes
  6. 🔁 Open a PR to get your changes merged
  7. 🚀 Profit!

👩‍⚖️ When contributing code to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.

If you just want to add a feature, all you need to do is...

  1. Fork this repository.
  2. Press . (period) on your keyboard to open GitHub.dev.
  3. Make any changes.
  4. Commit to your forked repo.
  5. Open a Pull Request to this repo.
  6. Profit! 🎉