forked from HubSpot/cms-theme-boilerplate
-
-
Notifications
You must be signed in to change notification settings - Fork 17
Getting started with contributing to the repo
Jon McLaren edited this page May 9, 2019
·
4 revisions
Hey, so awesome you're considering helping out.
This issue explains how we're structuring the files/folders You'll also see some of this detail in the markdown files in the folders.
- Make sure to checkout the mission.md file to understand what we're trying to achieve.
- If you've never used git before check out our new to git/github page.
- Look in the issues tab. Look for a task that sounds interesting or easy to you. Post to let people know you're working on it. Feel free to weigh in on any issues posted, as well as post your own.
- Do yo code thang, if it's a code related issue. If it's a discussion, discuss, do what needs doing.
- Focus on the code, not trying to be perfect with git. We can help you out with git and fortunately almost everything can be undone with git so don't be afraid to get in and get to coding.
- If it's a code related task submit a pull request and reference the issue number that you're addressing.
If there's something you think you can improve, feel free to create an issue, explain the idea and note that you can address it. If it's a minor change or a bug fix go ahead and give it a shot then submit a pull request. If it's a fairly big change - maybe waiting for a greenlight is a good idea to prevent wasted coding.
We're going to follow semantic versioning once we hit v1.0 - we're just not there yet so don't worry about version numbers for now.
LETS GET CODING!
Tips:
- if using VS Code, the extension Better Comments will color comments throughout the code to add emphasis. You are not required to use the extension, and it doesn't detract a ton to not use it, as the code will still visually have meaning when you see the symbols.
- If you really want to help push the project forward, focus on issues that are part of our Milestones Version 1.0 Milestone