Skip to content

Commit

Permalink
fix license badge
Browse files Browse the repository at this point in the history
add feature branch name restrictions
  • Loading branch information
coloradocolby committed May 30, 2022
1 parent e1641db commit c7212da
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 10 deletions.
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ merge of your pull request!
<!-- to check an item, place an "x" in the box like so: "- [x] Documentation" -->

- [ ] `Allow edits from maintainers` option checked
- [ ] Branch name is prefixed with `[your_username]/` (ex. `coloradocolby/featureX`)
- [ ] Documentation added
- [ ] Tests added
- [ ] No failing actions
Expand Down
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
<p align="center">
<img width="300" src="assets/thokr.svg">
</p>
<p align="center" style="font-size: 1.2rem;">a sleek typing tui written in rust</p>
<hr >
# thokr
✨ sleek typing tui written in rust

[![GitHub Build Workflow](https://github.com/coloradocolby/thokr/actions/workflows/build.yml/badge.svg)](https://github.com/coloradocolby/thokr/actions/workflows/build.yml)
[![GitHub Deploy Workflow](https://github.com/coloradocolby/thokr/actions/workflows/deploy.yml/badge.svg)](https://github.com/coloradocolby/thokr/actions/workflows/deploy.yml)
[![License](https://img.shields.io/badge/License-MIT-default.svg)](.github/LICENSE.md)
[![License](https://img.shields.io/badge/License-MIT-default.svg)](./LICENSE.md)
[![Crate Version](https://img.shields.io/crates/v/thokr)](https://crates.io/crates/thokr)
[![Github Stars](https://img.shields.io/github/stars/coloradocolby/thokr)](https://github.com/coloradocolby/thokr/stargazers)

Expand Down Expand Up @@ -102,18 +99,18 @@ create a [pull request](https://github.com/coloradocolby/thokr/pulls). You can
also simply open an issue and select `Feature Request`

1. Fork the repo
2. Create your feature branch (`git checkout -b feature/xyz`)
3. Commit your changes (`git commit -m 'Add some xyz'`)
2. Create your feature branch (`git checkout -b [your_username]/xyz`)
3. Commit your changes (`git commit -m 'add some xyz'`)
4. Rebase off main (`git fetch --all && git rebase origin/main`)
5. Push to your branch (`git push origin feature/xyz`)
5. Push to your branch (`git push origin [your_username]/xyz`)
6. Fill out pull request template

See the [open issues](https://github.com/coloradocolby/thokr/issues) for a full
list of proposed features (and known issues).

## License

Distributed under the MIT License. See [LICENSE.md](.github/LICENSE.md) for more
Distributed under the MIT License. See [LICENSE.md](./LICENSE.md) for more
information.

## Acknowledgments
Expand Down

0 comments on commit c7212da

Please sign in to comment.