Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pmarsceill authored Oct 25, 2018
1 parent 6a6efba commit 6400e79
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand All @@ -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-<version>.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).

0 comments on commit 6400e79

Please sign in to comment.