thang/notes
1
0
Fork 0
mirror of https://github.com/thangisme/notes.git synced 2024-12-21 07:36:38 -05:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Patrick Marsceill 2018-10-25 11:22:11 -04:00 committed by GitHub
parent 6a6efba27a
commit 6400e79e02
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -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-<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).