Skip to content

Commit d420311

Browse files
committed
docs: Update CONTRIBUTING.md and pull request template for clarity
- Corrected a typo in the CONTRIBUTING.md file, changing "comunity" to "community." - Added a new section in CONTRIBUTING.md titled "Important Considerations for Pull Requests" to emphasize the necessity of testing before submission. - Enhanced the pull request template to remind contributors to test their changes locally before submitting, ensuring a smoother review process.
1 parent a01ace1 commit d420311

2 files changed

Lines changed: 5 additions & 3 deletions

File tree

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Before submitting this PR, please make sure that:
88

99
- [ ] You created a dedicated branch based on the `canary` branch.
1010
- [ ] You have read the suggestions in the CONTRIBUTING.md file https://github.com/Dokploy/dokploy/blob/canary/CONTRIBUTING.md#pull-request
11-
- [ ] You have tested this PR in your local instance.
11+
- [ ] You have tested this PR in your local instance. If you have not tested it yet, please do so before submitting. This helps avoid wasting maintainers' time reviewing code that has not been verified by you.
1212

1313
## Issues related (if applicable)
1414

CONTRIBUTING.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Hey, thanks for your interest in contributing to Dokploy! We appreciate your help and taking your time to contribute.
44

5-
Before you start, please first discuss the feature/bug you want to add with the owners and comunity via github issues.
5+
Before you start, please first discuss the feature/bug you want to add with the owners and community via github issues.
66

77
We have a few guidelines to follow when contributing to this project:
88

@@ -11,6 +11,7 @@ We have a few guidelines to follow when contributing to this project:
1111
- [Development](#development)
1212
- [Build](#build)
1313
- [Pull Request](#pull-request)
14+
- [Important Considerations](#important-considerations-for-pull-requests)
1415

1516
## Commit Convention
1617

@@ -162,8 +163,9 @@ curl -sSL "https://github.com/buildpacks/pack/releases/download/v0.39.1/pack-v0.
162163
- If your pull request fixes an open issue, please reference the issue in the pull request description.
163164
- Once your pull request is merged, you will be automatically added as a contributor to the project.
164165

165-
**Important Considerations for Pull Requests:**
166+
### Important Considerations for Pull Requests
166167

168+
- **Testing is Mandatory:** All Pull Requests **must be tested** before submission. You must verify that your changes work as expected in a local development environment (see [Setup](#setup)). **Pull Requests that have not been tested will be closed.** This policy ensures clean contributions and reduces the time maintainers spend reviewing untested or broken code.
167169
- **Focus and Scope:** Each Pull Request should ideally address a single, well-defined problem or introduce one new feature. This greatly facilitates review and reduces the chances of introducing unintended side effects.
168170
- **Avoid Unfocused Changes:** Please avoid submitting Pull Requests that contain only minor changes such as whitespace adjustments, IDE-generated formatting, or removal of unused variables, unless these are part of a larger, clearly defined refactor or a dedicated "cleanup" Pull Request that addresses a specific `good first issue` or maintenance task.
169171
- **Issue Association:** For any significant change, it's highly recommended to open an issue first to discuss the proposed solution with the community and maintainers. This ensures alignment and avoids duplicated effort. If your PR resolves an existing issue, please link it in the description (e.g., `Fixes #123`, `Closes #456`).

0 commit comments

Comments
 (0)