Skip to content

Commit 7879d29

Browse files
committed
feat(devenv): add info about best practices to use before opening PRs
Signed-off-by: Alessio Pragliola <[email protected]>
1 parent 2c096e2 commit 7879d29

File tree

1 file changed

+37
-1
lines changed

1 file changed

+37
-1
lines changed

workspaces/controller/DEVELOPMENT.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010
- [In an existing cluster](#in-an-existing-cluster)
1111
- [Using kind](#using-kind)
1212
- [Teardown](#teardown)
13+
- [Pull Request Checklist](#pull-request-checklist)
14+
- [Best Practices](#best-practices)
1315
- [Troubleshooting](#troubleshooting)
1416
- ["Build Failed: failed to dial gRPC: unable to upgrade to h2c, received 404"](#build-failed-failed-to-dial-grpc-unable-to-upgrade-to-h2c-received-404)
1517

@@ -49,7 +51,6 @@ make -C devenv tilt-up
4951

5052
2. Hit `space` to open the Tilt dashboard in your browser and here you can see the logs and status of every resource deployed.
5153

52-
5354
## Teardown
5455

5556
To stop Tilt and remove all resources created by it, run:
@@ -60,6 +61,41 @@ make -C devenv tilt-down
6061

6162
ℹ️ Please make sure you are in the `workspaces/controller` directory when executing the command.
6263

64+
## Pull Request Checklist
65+
66+
Before raising a PR, ensure you run the following checks to maintain code quality and reliability:
67+
68+
1. **Linting**
69+
```bash
70+
make lint
71+
```
72+
- This runs static code analysis to ensure code style consistency
73+
- Fix any linting errors before proceeding
74+
75+
2. **Unit Tests**
76+
```bash
77+
make test
78+
```
79+
- Runs all unit tests in the project
80+
- Ensure all tests pass before submitting changes
81+
- Consider adding new tests for any new functionality
82+
83+
3. **End-to-End Tests**
84+
```bash
85+
make test-e2e
86+
```
87+
- Validates the complete workflow of the application
88+
- Requires a running Kubernetes cluster
89+
90+
### Best Practices
91+
92+
- Run tests locally before pushing changes
93+
- Write meaningful commit messages
94+
- Keep PRs focused and small
95+
- Update documentation if you change functionality
96+
- Consider adding new tests for new features
97+
- Run all checks in sequence before final submission
98+
6399
## Troubleshooting
64100

65101
### "Build Failed: failed to dial gRPC: unable to upgrade to h2c, received 404"

0 commit comments

Comments
 (0)