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

Latest commit

 

History

History
56 lines (37 loc) · 3.45 KB

CONTRIBUTING.md

File metadata and controls

56 lines (37 loc) · 3.45 KB
Raw

Contribution Guide

There are many ways to be an open source contributor, and we're here to help you on your way! You may:

  • Open up an issue or feature request on this repo click here to open an issue
  • Help another contributor with one of their questions, or a code review
  • Suggest improvements to our Getting Started documentation by supplying a Pull Request
  • Evangelize our work together in conferences, podcasts, and social media spaces.

This guide is for you.

🎉 Hacktoberfest 2024 🎉

tbd-examples is a participating in Hacktoberfest 2024! We’re so excited for your contributions, and have created a wide variety of issues so that anyone can contribute. Whether you're a seasoned developer or a first-time open source contributor, there's something for everyone.

Here's how you can get started:

  1. Read the code of conduct.
  2. Choose a task from this project's Hacktoberfest issues in our Project Hubs: Protocol Builder hub, DWA starter in VanillaJS hub, DWA starter in Vue hub. Each issue has the 🏷️ hacktoberfest label.
  3. Comment ".take" on the corresponding issue to get assigned the task.
  4. Fork the repository and create a new branch for your work.
  5. Make your changes and submit a pull request.
  6. Wait for review and address any feedback.

🏆 Leaderboard & Prizes

Be among the top 10 with the most points to snag custom swag just for you from our TBD shop! To earn your place in the leaderboard, we have created a points system that is explained below. As you complete tasks, you will automatically be granted a certain # of points.

Point System

Weight Points Awarded Description
🐭 Small 5 points For smaller tasks that take limited time to complete and/or don't require any product knowledge.
🐰 Medium 10 points For average tasks that take additional time to complete and/or require some product knowledge.
🐂 Large 15 points For heavy tasks that takes lots of time to complete and/or possibly require deep product knowledge.

Prizes

Top 10 contributors with the most points will be awarded TBD x Hacktoberfest 2024 swag. The Top 3 contributors will have special swag customized with your GitHub handle in a very limited design. (more info in our Discord)

👩‍ Need help?

Need help or have questions? Feel free to reach out by connecting with us in our Discord community to get direct help from our team in the #hacktoberfest project channel.

Happy contributing!

Note

  • Everything written within the body of the function will be extracted and added to a code-snippets-map.json file. These are not executable, they are only to be used for content.
  • return statements are excluded from being shown, however, we still need them for testing purposes
  • For situations where it doesn't make sense to return anything, we will exclude them from being tested

Remember

Adhere to the project's coding standards and guidelines. Before submitting your contribution, ensure all tests pass and your code is well-documented.

We look forward to your contributions and thank you for helping us improve this project!