Skip to content

Commit

Permalink
chore: improve contribution guideline [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
sheeiavellie committed Nov 14, 2024
1 parent a5ca7cf commit b9676e6
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 11 deletions.
26 changes: 22 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,24 @@
## Contribution guideline

1. Create an issue
2. Fork the repository
3. Do your magik
4. Open a pull request (please, put the link to previously opened issue in it's title)
### Contributing
You can contribute by:
- Reporting issues
- Suggesting new features and enhancements
- Improving documentation

For **minor** changes you can just send a PR without opening linked issue.

For **major** changes open an issue.

### Commits and PRs
I highly encourage using [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/ "conventional commits") style in commit messages.

For PR titles it is *required* to use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/ "conventional commits") style titles.

You can use any of these prefixes:
- fix
- feat
- chore
- refactor
- test
- ci
39 changes: 32 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,15 +60,40 @@ func main() {

You can get all the necessary information from the [official documentation](https://cloud.yandex.ru/en/docs/yandexgpt/quickstart).

## Contributing
## Contribution guideline

1. Create an issue
2. Fork the repository
3. Do your magik
4. Open a pull request (please, put the link to previously opened issue in it's title)
### Contributing
You can contribute by:
- Reporting issues
- Suggesting new features and enhancements
- Improving documentation

## Thank you very much
For **minor** changes you can just send a PR without opening linked issue.

This project was ***highly*** inspired by [go-openai](https://github.com/sashabaranov/go-openai) by [sashabaranov](https://github.com/sashabaranov)
For **major** changes open an issue.

### Commits and PRs
I highly encourage using [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/ "conventional commits") style in commit messages.

For PR titles it is *required* to use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/ "conventional commits") style titles.

You can use any of these prefixes:
- fix
- feat
- chore
- refactor
- test
- ci

## Credits 🖼️

- [Alexander V. Trotsky](https://github.com/sheeiavellie "Alexander V. Trotsky") (Author)
- [Contributors](https://github.com/sheeiavellie/go-yandexgpt/graphs/contributors "Contributors")

## Acknowledgement
#### Thank you very much

This project was ***highly*** inspired by [go-openai](https://github.com/sashabaranov/go-openai) by [sashabaranov](https://github.com/sashabaranov)
_______________
*Made with 💖 and some wizardry 🧙🔮*

0 comments on commit b9676e6

Please sign in to comment.