Welcome! We are excited you're interested in contributing to Redwood for #Hacktoberfest You'll be in good company with over 120+ other project contributors 🚀
Note: we have been following the update Hacktoberfest Guidelines as best we can. If you see anything missing from our setup, just let us know. And the last week of October we'll sort through PRs that might not get merged in time and add the hacktoberfest-accepted
label — however, it will help us if you remind us the last week via a comment on an open PR.
Redwood is a Community
The most important thing you need to know is that Redwood consists of a vibrant community of people from all over the world. Together we believe that making each other successful with Redwood is how we make Redwood successful. The best ways to get connected to the community are to reach out:
Please introduce yourself! And don't forget to lead with gratitude and generosity, which encourages others to respond with like-kind. 😃
Getting Started
What: Find something you're excited to contribute 🎉
Find an Existing Issue
There are three Redwood Projects participating in Hacktoberfest:
- Framework
- Website and Docs
- Installation Template
For each of these projects, we have a label for good-first-issue
, which you may find helpful. For example, here are the issues labeled for the Framework:
And for #Hacktoberfest we have a specific label as well.
Create a New Issue: Contributions we'll accept
If this is your first time contributing, we recommend starting with an existing issue.
For other contributions, we are looking specifically for help getting Redwood to v1.0. The best place to start is by reading the v1.0 Roadmap and looking at the project boards for categories of interest:
You'll want to start by first opening an Issue and proposing a problem + solution. Often it helps to show some example code. But this is meant to be a lightweight first-step to start a conversation. We don't want you to go to a bunch of work up-front only to find out it's not a fit. When in doubt, just ask!
How: What you need to know to contribute
Once you've found something you're excited to work on, the next step is learning how to make a contribution.
The first step is to read through the Contributing doc on our website:
This includes a lot of links to other docs and guides you'll need depending on which project you want to work on.
Questions?
We understand that setting up a local environment isn't trivial. Once you've taken a look at the docs and done the initial setup, please don't hesitate to reach out with questions if anything is in your way. We'd be happy to help!
Otherwise, we'll be watching this Issue as well. Please comment in this thread and someone will reply when they're available.
Happy hacking! 👩💻👨💻👕