This repository has been archived by the owner on Dec 12, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Hacktoberfest 2024 MD Docs Update (#124)
Co-authored-by: Tania Chakraborty <[email protected]>
- Loading branch information
1 parent
967add2
commit d498acf
Showing
2 changed files
with
69 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
# 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](https://github.com/TBD54566975/developer.tbd.website/issues/new) | ||
- 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](https://github.com/TBD54566975/tbd-examples/blob/main/CODE_OF_CONDUCT.md). | ||
2. Choose a task from this project's Hacktoberfest issues in our Project Hubs: [Protocol Builder hub](https://github.com/TBD54566975/tbd-examples/issues/97), [DWA starter in VanillaJS hub](https://github.com/TBD54566975/tbd-examples/issues/81), [DWA starter in Vue hub](https://github.com/TBD54566975/tbd-examples/issues/63). Each issue has the 🏷️ `hacktoberfest` label. | ||
5. Comment ".take" on the corresponding issue to get assigned the task. | ||
6. Fork the repository and create a new branch for your work. | ||
7. Make your changes and submit a pull request. | ||
8. 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](https://discord.gg/tbd) 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! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,16 @@ | ||
# TBD Examples | ||
|
||
A variety of example applications using TBD libraries, organized by language. | ||
|
||
## 🎉 Hacktoberfest 2024 🎉 | ||
|
||
`tbd-examples` is a participating project 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. | ||
|
||
### To get started: | ||
1. Read the [contributing guide](https://github.com/TBD54566975/tbd-examples/blob/main/CONTRIBUTING.md). | ||
2. Read the [code of conduct](https://github.com/TBD54566975/tbd-examples/blob/main/CODE_OF_CONDUCT.md). | ||
3. Choose a task from this project's Hacktoberfest issues in our Project Hubs: [Protocol Builder hub](https://github.com/TBD54566975/tbd-examples/issues/97), [DWA starter in VanillaJS hub](https://github.com/TBD54566975/tbd-examples/issues/81), [DWA starter in Vue hub](https://github.com/TBD54566975/tbd-examples/issues/63). Each issue has the 🏷️ `hacktoberfest` label. | ||
|
||
Have questions? Connecting with us in our [Discord community](https://discord.gg/tbd) in the `#hacktoberfest` project channel. | ||
|
||
--- |