Skip to content

Commit 27ea235

Browse files
authored
Merge pull request #156 from instadeepai/docs-small-fixes
docs: small typo and commit style fixes to docs and README
2 parents 767a464 + e3cbfcd commit 27ea235

2 files changed

Lines changed: 6 additions & 10 deletions

File tree

README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -187,9 +187,9 @@ If you have ideas for enhancements, you can:
187187
### Contribution process
188188

189189
1. Fork the repository.
190-
2. Create a feature branch (`git checkout -b feature-amazing-feature`).
191-
3. Commit your changes (`git commit -m 'Add some amazing feature'`).
192-
4. Push to your branch (`git push origin feature-amazing-feature`).
190+
2. Create a feature branch (`git checkout -b feat-amazing-feature`).
191+
3. Commit your changes (`git commit -m 'feat: add some amazing feature'`).
192+
4. Push to your branch (`git push origin feat-amazing-feature`).
193193

194194
Don't forget to give the project a star! Thanks again! :star:
195195

@@ -200,10 +200,6 @@ Don't forget to give the project a star! Thanks again! :star:
200200
If you use `winnow` in your research, please cite the following preprint:
201201

202202
```bibtex
203-
@article{mabona2025novopeptidesequencingrescoring,
204-
title={De novo peptide sequencing rescoring and FDR estimation with Winnow},
205-
author={Amandla Mabona and Jemma Daniel and Henrik Servais Janssen Knudsen and Rachel Catzel
206-
and Kevin Michael Eloff and Erwin M. Schoof and Nicolas Lopez Carranza and Timothy P. Jenkins
207203
@article{mabona2025novopeptidesequencingrescoring,
208204
title={De novo peptide sequencing rescoring and FDR estimation with Winnow},
209205
author={Amandla Mabona and Jemma Daniel and Henrik Servais Janssen Knudsen

docs/contributing.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ If you have ideas for enhancements, you can:
2222

2323
2. **Create a feature branch**
2424
```bash
25-
git checkout -b feature-amazing-feature
25+
git checkout -b feat-amazing-feature
2626
```
2727

2828
3. **Set up development environment**
@@ -50,12 +50,12 @@ If you have ideas for enhancements, you can:
5050

5151
6. **Commit your changes**
5252
```bash
53-
git commit -m 'Add some amazing feature'
53+
git commit -m 'feat: add some amazing feature'
5454
```
5555

5656
7. **Push to your branch**
5757
```bash
58-
git push origin feature-amazing-feature
58+
git push origin feat-amazing-feature
5959
```
6060

6161
8. **Open a Pull Request**

0 commit comments

Comments
 (0)