Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (40 loc) · 3.96 KB

CONTRIBUTING.md

File metadata and controls

63 lines (40 loc) · 3.96 KB

Hi there! Interested in contributing to my blog? I'd love your help. This blog is an open source project, built one contribution at a time by users like you.

Where to get help or report a problem or suggest an enhancement

Submit an issue

Ways to contribute

There are lots of ways to contribute. Here's a few ideas:

  • Install this on your computer locally (for offline viewing) and kick the tires. Does it work? Does it do what you'd expect? If not, open an issue and let us know.
  • Comment on some of the project's open issues. Have you experienced the same problem? Know a work around? Do you have a suggestion for how the feature could be better?
  • Read through the content, and click the "improve this page" button, any time you see something confusing, or have a suggestion for something that could be improved.
  • Find an open issue (especially those labeled help-wanted), and submit a proposed fix. If it's your first pull request, I promise I won't bite, and I'm glad to answer any questions.
  • Help evaluate open pull requests, by testing the changes locally and reviewing what's proposed.

Submitting a pull request

Pull requests generally

  • The smaller the proposed change, the better. If you'd like to propose two unrelated changes, submit two pull requests.

  • The more information, the better. Make judicious use of the pull request body. Describe what changes were made, why you made them, and what impact they will have for users.

  • If this is your first pull request, it may help to understand GitHub Flow.

Submitting a pull request via github.com

Many small changes can be made entirely through the github.com web interface.

  1. Navigate to the file within jacebenson/blog that you'd like to edit.
  2. Click the pencil icon in the top right corner to edit the file
  3. Make your proposed changes
  4. Click "Propose file change"
  5. Click "Create pull request"
  6. Add a descriptive title and detailed description for your proposed change. The more information the better.
  7. Click "Create pull request"

That's it! You'll be automatically subscribed to receive updates as others review your proposed change and provide feedback.

Submitting a pull request via Git command line

  1. Fork the project by clicking "Fork" in the top right corner of jacebenson/blog.
  2. Clone the repository locally git clone https://github.com/<you-username>/blog.
  3. Create a new, descriptively named branch to contain your change ( git checkout -b my-awesome-feature ).
  4. Hack away, add tests. Not necessarily in that order.
  5. Push the branch up ( git push origin my-awesome-feature ).
  6. Create a pull request by visiting https://github.com/<your-username>/blog and following the instructions at the top of the screen.

Proposing updates to the documentation

We want the Jekyll documentation to be the best it can be. We've open-sourced our docs and we welcome any pull requests if you find it lacking.

How to submit changes

You can find the content for blog.jacebenson.com in the docs directory. See the section above, submitting a pull request for information on how to propose a change.

One gotcha, all pull requests should be directed at the master branch (the default branch).

A thank you

Thanks! Hacking on this blog should be fun. If you find any of this hard to figure out, let us know so we can improve our process or documentation!