forked from HubSpot/cms-theme-boilerplate
-
-
Notifications
You must be signed in to change notification settings - Fork 17
New to Git and GitHub?
Jon McLaren edited this page May 20, 2019
·
5 revisions
Here are some resources to help you get going. Remember that Master should always be stable working code because of that we never directly edit Master on the main CrankShaft Repo. You can do this safely on a fork if you want.
- Fork the repo if you don't have contributor access.
- Make your changes on your fork
- Submit a pull request from your fork to CrankShaft Master. (If your PR is related to an issue please post the issue number in your PR) At a later point in time we will have a develop or version number branch to PR to instead, but don't worry about that for now.
- We review, suggest changes if necessary, and approve and merge the changes.
- Learn by doing using GitHub Lab
- GitHub has tons of great guides
- GitHub Flow will help you understand the best practice for dealing with branches.
When submitting a pull request or resolving an issue it's helpful to note the issue number, that way others have the full context of what you're doing.
There are GUI programs that can make it easier to understand.
- GitHub Desktop
- SourceTree
- Once comfortable with either command line or with how git works, VS Code has a great git system built in.
we're not yet at a point where we're at a first real release, once we are we will use semantic versioning - to make it easy, the primary contributors will be the ones changing the version number, it just helps to understand what semantic versioning is as it's useful and may come in handy on future projects.