Skip to content

Commit

Permalink
Added checklist to PR template to enforce standards (#2653)
Browse files Browse the repository at this point in the history
* Added checklist to PR template

* Updated contributing docs

* Added proper markdown syntax
  • Loading branch information
adithyanotfound authored Nov 23, 2024
1 parent 2e1ed6f commit 825515d
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 11 deletions.
29 changes: 18 additions & 11 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This section can be deleted after reading.
We employ the following branching strategy to simplify the development process and to ensure that only stable code is pushed to the `master` branch:
- `develop`: For unstable code: New features and bug fixes.
- `master`: Where the stable production ready code lies. Only security related bugs.
- `master`: Where the stable production-ready code lies. Only security-related bugs.
NOTE!!!
Expand All @@ -15,39 +15,46 @@ ONLY SUBMIT PRS AGAINST OUR `DEVELOP` BRANCH. THE DEFAULT IS `MAIN`, SO YOU WILL
Thanks for submitting a pull request! Please provide enough information so that others can review your pull request.
-->

**What kind of change does this PR introduce?**
### What kind of change does this PR introduce?

<!-- E.g. a bugfix, feature, refactoring, etc… -->

**Issue Number:**
### Issue Number:

Fixes #<!--Add related issue number here and delete this comment text block.-->

**Did you add tests for your changes?**
### Did you add tests for your changes?

<!--Yes or No. Note: Add unit tests or automation tests for your code.-->

**Snapshots/Videos:**
- [ ] Tests are written for all changes made in this PR.
- [ ] Test coverage meets or exceeds the current coverage (~90/95%).

Snapshots/Videos:

<!--Add snapshots or videos wherever possible.-->

**If relevant, did you update the documentation?**
### If relevant, did you update the documentation?

<!--Add link to Talawa-Docs.-->

**Summary**
### Summary

<!-- Explain the **motivation** for making this change. What existing problem does the pull request solve? -->
<!-- Explain the motivation for making this change. What existing problem does the pull request solve? -->
<!-- Try to link to an open issue for more information. -->

**Does this PR introduce a breaking change?**
### Does this PR introduce a breaking change?

<!-- If this PR introduces a breaking change, please describe the impact and a migration path for existing applications. -->

**Other information**
### Checklist for Repository Standards
- [ ] Have you reviewed and implemented all applicable `coderaabbitai` review suggestions?
- [ ] Have you ensured that the PR aligns with the repository’s contribution guidelines?

### Other information

<!--Add extra information about this PR here-->

**Have you read the [contributing guide](https://github.com/PalisadoesFoundation/talawa/blob/master/CONTRIBUTING.md)?**
### Have you read the [contributing guide](https://github.com/PalisadoesFoundation/talawa/blob/master/CONTRIBUTING.md)?

<!--Yes or No-->
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,8 @@ The value of `safeBlockVertical` and `safeBlockHorizontal` will be displayed in
- All your file should contain at max `300` lines of code.
- Follow proper code formatting and run `flutter format .` before your PR.
- Run `flutter analyze` before your PR and make sure to resolve all the found issues.
- Tests must be written for all code changes, ensuring they maintain or exceed the current code coverage threshold.
- Ensure your pull request is approved by Coderaabbitai by addressing and implementing all its suggestions.
### Project Structure
Expand Down

0 comments on commit 825515d

Please sign in to comment.