Skip to content

Commit 4348b34

Browse files
committed
fixes from feedback
1 parent 644d46b commit 4348b34

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ When reporting a bug, please try and provide as much context as possible such as
2727

2828
## Submitting Modifications
2929

30-
1. It's generally best to start by opening a new issue describing the bug or feature you're intending to fix. Even if you think it's relatively minor, it's helpful to know what people are working on. Mention in the initial issue that you are planning to work on that bug or feature so that it can be assigned to you.
30+
1. It's generally best to start by opening a new issue describing the bug or feature you intend to fix. Even if you think it's relatively minor, it's helpful to know what people are working on. Mention in the initial issue that you are planning to work on that bug or feature so that it can be assigned to you.
3131

32-
2. Follow the normal process of [forking](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the project, and setup a new branch to work in. It's important that each group of changes be done in separate branches in order to ensure that a pull request only includes the commits related to that bug or feature.
32+
2. Follow the normal process of [forking](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the project, and setup a new branch to work in. Each group of change must be done in separate branches in order to ensure that a pull request only includes the commits related to that bug or feature.
3333

34-
3. Do your best to have [well-formated commit messages](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) for each change. This provides consistency throughout the project and ensures that commit messages are able to be formatted properly by various git tools.
34+
3. Do your best to have [well-formated commit messages](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) for each change. This provides consistency throughout the project and ensures that commit messages can be adequately formatted by various git tools.
3535

3636
4. Finally, push the commits to your fork and submit a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
3737

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -104,12 +104,12 @@ run: /ops/main
104104
105105
## Documentation
106106
107-
- You can find the CTO.ai and CTO.ai Go SDK documentation [on the docs website](https://cto.ai/docs/golang-sdk-overview)
107+
- You can find the CTO.ai Go SDK documentation [on the docs website](https://cto.ai/docs/golang-sdk-overview)
108108
109109
110110
## Contributing
111111
112-
The main aim of this repository is to continue developing and advancing CTO.ai Go, making it faster and more simplified to use. Kindly check our [contributing guide](https://github.com/cto-ai/sdk-go/blob/master/CONTRIBUTING.md) on how to propose bugfixes and improvements, and submitting pull requests to the project.
112+
The main aim of this repository is to continue developing and advancing CTO.ai Go, making it faster and more simplified to use. Kindly check our [contributing guide](https://github.com/cto-ai/sdk-go/blob/master/CONTRIBUTING.md) on how to propose bug fixes and improvements, as well as submit pull requests to the project.
113113
114114
115115
## License

0 commit comments

Comments
 (0)