Skip to content
This repository has been archived by the owner on Jun 5, 2024. It is now read-only.

Commit

Permalink
docs: updated CONTRIBUTING.md to include commit guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
bizob2828 committed Dec 21, 2023
1 parent 9c36a76 commit cc52d37
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,30 @@ If you’re planning on contributing a new feature or an otherwise complex contr

In general, we try to limit adding third-party production dependencies. If one is necessary, please be prepared to make a clear case for the need.

### Commit Guidelines

We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) to format commit messages for this repository. Conventional Commits provide a standardized format for commit messages that allows for automatic generation of changelogs and easy tracking of changes.

When contributing to this repository, please ensure that your commit messages adhere to the Conventional Commit guidelines. Specifically, your commit messages should:

* Start with a type, indicating the kind of change being made (e.g. `feat` for a new feature, `fix` for a bugfix, etc.). The types we support are:
* `build`: changes that affect the build system or external dependencies
* `chore`: changes that do not modify source or test files
* `ci`: changes to our CI configuration files and scripts
* `docs`: documentation additions or updates
* `feat`: new features or capabilities added to the agent
* `fix`: bugfixes or corrections to existing functionality
* `perf`: performance improvements
* `refactor`: changes that do not add new feature or fix bugs, but improve code structure or readability
* `revert`: revert a previous commit
* `security`: changes related to the security of the agent, including the updating of dependencies due to CVE
* `style` - changes that do not affect the meaning of the code (e.g. formatting, white-space, etc.)
* `test` - adding new tests or modifying existing tests
* Use the imperative, present tense (e.g. "add feature" instead of "added feature")
* Optionally, include a scope in parantheses after the type to indicate which part of the repository is affected (e.g. `feat(instrumentation): add support for Prisma Client`)

Please note that we use the [Squash and Merge](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-commits) method when merging Pull Requests into the main branch. We do not use the original commit messages from each individual commit. Instead, we use the Pull Request title as the commit message for the squashed commit, and as such, require that the Pull Request title adheres to our Conventional Commit standards. Any additional documentation or information relevant to the release notes should be added to the "optional extended description" section of the squash commit on merge.

### Coding Style Guidelines/Conventions

We use eslint to enforce certain coding standards. Please see our [.eslintrc](./.eslintrc.js) file for specific rule configuration.
Expand Down

0 comments on commit cc52d37

Please sign in to comment.