Skip to content

Commit 0767594

Browse files
committed
docs: add contributing guidelines for commit messages
1 parent 08198b0 commit 0767594

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,24 @@ Contributions are **welcome** and will be fully **credited**.
55
We accept contributions via Pull Requests on [Github](https://github.com/yajra/laravel-datatables-export).
66

77

8+
## Commit messages — Conventional Commits (recommended)
9+
10+
We follow the Conventional Commits specification for all commit messages to keep history clear and to allow automated changelog/release tooling.
11+
12+
- Format: `<type>(optional-scope): <short-description>`
13+
- Examples:
14+
- `feat: add export queue support`
15+
- `fix(export): handle empty dataset exception`
16+
- `chore(deps): bump phpunit to ^10.0`
17+
- `docs: update README with contrib guidelines`
18+
19+
Types we commonly use: `feat`, `fix`, `chore`, `docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`.
20+
21+
This is a documentation-only guideline. There is no required tooling in the repository to enforce commit messages; contributors are asked to follow the format when writing commit messages. If you prefer to use local tooling (for example `commitlint` + `husky`) that's fine, but it's not required by the maintainers.
22+
23+
If you run into issues or have questions about commit formatting, open an issue or drop a note in the PR — maintainers can help.
24+
25+
826
## Pull Requests
927

1028
- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).
@@ -16,4 +34,4 @@ We accept contributions via Pull Requests on [Github](https://github.com/yajra/l
1634
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.
1735

1836

19-
**Happy coding**!
37+
**Happy coding**!

0 commit comments

Comments
 (0)