Skip to content

Commit 53d0fb1

Browse files
authored
Mention AI generated code & conventional commits
1 parent 436742f commit 53d0fb1

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

‎CONTRIBUTING.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ There are several ways you can contribute to `dart_seq`:
1616
- Create a new branch for your changes: `git checkout -b feature/your-feature-name`.
1717
- Make your code changes, adhering to the project's coding style and guidelines.
1818
- Write appropriate tests for your changes, ensuring that they pass successfully.
19-
- Commit your changes with a descriptive commit message: `git commit -m "Add new feature: your feature name"`.
19+
- Commit your changes (preferably using [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)): `git commit -m "feat: adds x"`.
20+
- Include the _reason_ for making the change, not _what_ you changed
2021
- Push your branch to your forked repository: `git push origin feature/your-feature-name`.
2122
- Open a pull request on the [GitHub repository](https://github.com/ricardoboss/dart_seq/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc), explaining your changes and providing any necessary context.
2223

@@ -28,6 +29,7 @@ To maintain a consistent codebase and ensure readability, please adhere to the f
2829
- Write clear, concise, and self-explanatory code with appropriate comments where necessary.
2930
- Ensure that your code passes all existing tests, and write additional tests for any new features or changes.
3031
- Document any public APIs using DartDoc comments to provide clear and comprehensive documentation.
32+
- AI generated code is generally ok, but refrain from making too many changes at once. Each commit (and each PR) should focus on one change at a time.
3133

3234
## Communication
3335

0 commit comments

Comments
 (0)