mirror of
https://github.com/thangisme/notes.git
synced 2024-11-20 01:55:56 -05:00
Update README.md
This commit is contained in:
parent
6a6efba27a
commit
6400e79e02
17
README.md
17
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.
|
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
|
## Development
|
||||||
|
|
||||||
To set up your environment to develop this theme, run `bundle install`.
|
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 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
|
## License
|
||||||
|
|
||||||
The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user