From 6400e79e022961f3b3a2751f0de8f5c305e4941f Mon Sep 17 00:00:00 2001 From: Patrick Marsceill Date: Thu, 25 Oct 2018 11:22:11 -0400 Subject: [PATCH] Update README.md --- README.md | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 3df45b1..7e2181d 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,13 @@ Or install it yourself as: Bug reports and pull requests are welcome on GitHub at https://github.com/pmarsceill/just-the-docs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. +### Submitting code changes: + +- Open a [Pull Request](https://github.com/pmarsceill/just-the-docs/pulls) +- Ensure all CI tests pass +- Await code review +- Bump the version number in `just-the-docs.gemspec` and `package.json` according to [semantic versioning](https://semver.org/). + ## Development To set up your environment to develop this theme, run `bundle install`. @@ -43,16 +50,6 @@ Your theme is setup just like a normal Jekyll site! To test your theme, run `bun When the theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be released. - -### When your changes are ready: - -- Open a [Pull Request](https://github.com/pmarsceill/just-the-docs/pulls) -- Await code review -- Bump the version number in `just-the-docs.gemspec` -- Run `script/build` to package the gem -- Run `gem push just-the-docs-.gem` to publish the gem to Rubygems.org - ## License The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). -