The Cody repository is shared amongst many members of the engineering team, and will follow similar guidelines from ‣
Each pull request title should follow the format $type/($domain): $what, where:
<aside> 📣
$type indicates the nature of the changes, and is one of:
chore : maintenance or refactoring that doesn’t affect the behaviour or very slightlyfeat : introduces new behaviour or featurefix : fixes a bug or incorrect behaviour.changed: changes a feature behaviour$domain indicates what domain is affected by the changes. It is used to group entries into sections, to help with the readability of the changelog.
Finally $what is up to you but should try to word it in terms of the value add to the customer.
</aside>
Source: ‣
$domainsAll PRs in the Cody repo should be, not limited to one of the following domains:
| Domain name | Description |
|---|---|
| ci | Changes related to CI, which includes - adding tests, machines, workflow updates, etc |
| autocomplete | Changes related to autocomplete functionality or behaviour |
| chat | Changes related to the main chat input that affects functionality or behaviour |
| edit | Changes related to the inline editing feature |
| models | Additions or subtractions to the models we provide |
| agent | ??? |
| context | Changes related to how we provide context |
| prompts | Changes to how the prompt library is used on the client |
| release | Anything release related, version bumps, token swaps, etc |
| settings | Anything related to settings in the cody client |
| logging | Anything logging or telemetry related |
| changelog | Changes to the changelog |
By adding a content under the ## Changelog section, you can add more context about your changes, which will be added under that particular entry in the generated changelog.
Given the following PR:
Pull Request Number: ****12345
Pull Request Title: ****chore(search): faster full text results