Skip to content

Commit 3689ea6

Browse files
committed
chore(docs): update contributing and simplify PR template
1 parent 9582e60 commit 3689ea6

File tree

2 files changed

+6
-63
lines changed

2 files changed

+6
-63
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 0 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -3,69 +3,12 @@
33
- Fixes: <!-- #(issue) -->
44
- Closes: <!-- #(issue) -->
55

6-
## Checklist
7-
8-
- [ ] This PR conforms to the guidelines in [CONTRIBUTING.md](../CONTRIBUTING.md)
9-
- [ ] It has a descriptive title
10-
- [ ] My commits conform to the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) specification
11-
- [ ] This PR is not a duplicate of a similar PR ([how to search issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests) for similar/duplicate PRs, which this is not
12-
- [ ] This PR targets the `dev` branch
13-
- [ ] I ran the pre-commit hooks or `npm test && npm lint && npm test:e2e` and all tests pass
14-
15-
<hr>
16-
176
## Description
187

198
<!--
209
Please include a summary of the change and which issue it addresses. Include the motivation for the changes and any additional context.
2110
-->
2211

23-
## Type of Change
24-
25-
<!--
26-
Please delete options that are not relevant.
27-
-->
28-
29-
- [ ] Bug fix (non-breaking change which fixes an issue)
30-
- [ ] New feature (non-breaking change which adds functionality)
31-
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
32-
- [ ] Documentation update
33-
- [ ] Code cleanliness (removal of unnecessary comments or debug logs)
34-
35-
## How Has This Been Tested?
36-
37-
<!--
38-
Please describe the tests that you ran to verify your changes.
39-
- Please Provide instructions so we can reproduce the scenarios.
40-
- Please List any relevant details for your test configuration.
41-
42-
- [ ] Test A
43-
- [ ] Test B
44-
-->
45-
<!--
46-
**Test Configuration** (Optional):
47-
48-
- Firmware version:
49-
- If you know the version of any specific software you used, list it here. If unsure, you can leave it blank.
50-
- Hardware:
51-
- Mention your computer or device model if your changes are hardware-dependent. If not, it's okay to skip.
52-
- Toolchain:
53-
- This refers to the set of programming tools you used. For beginners, it could be the IDE (Integrated Development Environment) like Visual Studio Code.
54-
- SDK:
55-
- Mention any specific Software Development Kit versions you used. If you didn't use any, no need to include it.
56-
-->
57-
58-
## Microservices and API Integration
59-
60-
- [ ] If applicable, my changes are compatible with the project's microservices architecture and API gateway integration requirements.
61-
62-
## Checklist:
63-
64-
- [ ] My code follows the style guidelines of this project
65-
- [ ] I have made corresponding changes to the documentation
66-
- [ ] I have removed all unnecessary comments and debug log statements
67-
- [ ] I have linked this PR to its corresponding issue
68-
6912
## Screenshots (if appropriate):
7013

7114
Please review and suggest any further insights, improvements, or modifications needed.

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,8 @@ These prefixes are among the most commonly used in branch naming conventions:
7878
Check out this resources for more details
7979
[Best Practices to Follow](https://phoenixnap.com/kb/git-branch-name-convention)
8080

81+
_While working in your own fork you are welcome to work off your own `main` branch and label pull requests descriptively instead if preferred_
82+
8183
## Pre-commit Setup
8284

8385
To set up pre-commit hooks for your project, you'll need to install the pre-commit package manager.
@@ -94,8 +96,6 @@ Our project uses GitHub Actions for continuous integration (CI) and deployment t
9496

9597
### Deploy to GitHub Pages Workflow
9698

97-
**Trigger**: This workflow is triggered on pushes to the dev branch and can also be run manually via GitHub's Actions tab.
98-
9999
**Purpose**: It's designed to build the project using Astro and deploy it to GitHub Pages. This ensures that our development progress is automatically compiled and made visible for testing and preview.
100100

101101
Steps:
@@ -104,13 +104,13 @@ Steps:
104104

105105
- **Build and Upload**: The site is built using Astro, and the output is prepared for deployment.
106106

107-
- **Deployment**: The built site is deployed to GitHub Pages.
107+
- **Deployment**: The built site is deployed to GitHub Pages. It will be deployed when commits are tagged for relase with semver.
108108

109109
**Contributors should target their feature branches towards the dev branch for any site updates or changes. This branch is our staging area for the website.**
110110

111111
### Frontend CI Workflow
112112

113-
**Trigger**: This workflow is activated on push or pull request events for the dev and prod branches. It supports manual triggers as well.
113+
**Trigger**: This workflow is activated on push or pull request events for the prod branch. It supports manual triggers as well.
114114

115115
**Purpose**: To ensure that frontend changes (e.g., style updates, JavaScript modifications) do not break the build. It helps maintain the integrity of our codebase.
116116

@@ -157,11 +157,11 @@ Please see the [Conventional Commits website](https://www.conventionalcommits.or
157157

158158
1. Fork the Project
159159
2. Clone your Fork
160-
3. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
160+
3. Create your Feature Branch if desired (`git checkout -b feature/AmazingFeature`)
161161
4. Commit your Changes (`git commit -m 'feat: Add some AmazingFeature'`)
162162
**[see above commit prefixes](#conventional-commits)**
163163
5. Push to the Branch (`git push origin feature/AmazingFeature`)
164-
6. Open a Pull Request
164+
6. Open a Pull Request against the `tulsawebdevs/website:prod` branch
165165

166166
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
167167
- Update the README.md with details of changes to the interface, including new environment variables, exposed ports, useful file locations, and container parameters.

0 commit comments

Comments
 (0)