Skip to content

Contribution Guidelines

James Tang edited this page Sep 13, 2016 · 3 revisions

Fork the Repo (For general contributions)

  1. Fork the project https://guides.github.com/activities/forking/
  2. Clone your project
git clone [email protected]:<your github username>/CSStickyHeaderFlowLayout.git

Committing Changes

It's a good practice to create a feature branch, even when you've just planning to do one commit:

git checkout -b crash_fix_issue_1

For every changes you made, write a descriptive commit message:

git commit -m "Fixes #1 Crash while scrolling"

Submitting Pull Request

  1. Push your branch to your repository
git push origin -u crash_fix_issue_1
  1. Creating a pull request

Becoming Repo Owner to create a new release

Please send me your email and your github username:

Title: Registering as CSStickyHeaderFlowLayout as repo owner
Body: Hi, my github username is @jamztang, cocoapods email is [email protected]

Replace with your own info, and I'll register you as owner on CocoaPods) Also, setting you as a github's repo owner

Creating a New Release (for repo owners)

Merged the pull request to master

git checkout master
git merge --no-ff crash_fix_issue_1

Use your favourite editor, update the version number and make necessary changes to the CSStickyHeaderFlowLayout.podspec

And also necessary changes to README.md

Commit the changes

git add .
git commit -m "Update podspec to version 0.0.2"

Tag your commit

git tag -a 0.0.2 -m "Merged fixes for #1 and #2"

Push commit and tag to master

git push origin master -u --tags

Pushing to CocoaPods

pod trunk push CSStickyHeaderFlowLayout.podspec