Skip to content

Commit 2c08771

Browse files
Chore: Updated changelog and added contribution terms and pull request template.
1 parent 0af5810 commit 2c08771

File tree

3 files changed

+84
-1
lines changed

3 files changed

+84
-1
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<!--
2+
- Fill in the form below correctly. This will help the Codelabmw team to understand the PR and also work on it.
3+
-->
4+
5+
### What:
6+
7+
- [ ] Bug Fix
8+
- [ ] New Feature
9+
10+
### Description:
11+
12+
<!-- describe what your PR is solving -->
13+
14+
### Related:
15+
16+
<!-- link to the issue(s) your PR is solving. If it doesn't exist, remove the "Related" section. -->

CHANGELOG.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
11
# Changelog
22

3-
All notable changes to `suave` will be documented in this file.
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](http://keepachangelog.com/)
6+
and this project adheres to [Semantic Versioning](http://semver.org/).
7+
8+
## [1.0.0] - 2025-01-06
9+
10+
### Added
11+
12+
- Session authentication support.
13+
- Token authentication support.
14+
- Email verification.
15+
- Forgot password.
16+
- Password reset.

CONTRIBUTING.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# CONTRIBUTING
2+
3+
Contributions are welcome, and are accepted via pull requests.
4+
Please review these guidelines before submitting any pull requests.
5+
6+
## Process
7+
8+
1. Fork the project
9+
1. Create a new branch
10+
1. Code, test, commit and push
11+
1. Open a pull request detailing your changes. Make sure to follow the [template](.github/PULL_REQUEST_TEMPLATE.md)
12+
13+
## Guidelines
14+
15+
* Please ensure the coding style running `composer lint`.
16+
* Send a coherent commit history, making sure each individual commit in your pull request is meaningful.
17+
* You may need to [rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) to avoid merge conflicts.
18+
* Please remember that we follow [SemVer](http://semver.org/).
19+
20+
## Setup
21+
22+
Clone your fork, then install the dev dependencies:
23+
24+
```bash
25+
composer install
26+
```
27+
28+
## Lint
29+
30+
Lint your code:
31+
32+
```bash
33+
composer lint
34+
```
35+
36+
## Tests
37+
38+
Run all tests:
39+
40+
```bash
41+
composer test
42+
```
43+
44+
Check types:
45+
46+
```bash
47+
composer test:types
48+
```
49+
50+
Unit tests:
51+
52+
```bash
53+
composer test
54+
```

0 commit comments

Comments
 (0)