feat: write style guide (#52)

Reviewed-on: https://codeberg.org/nhcarrigan/docs/pulls/52
Co-authored-by: Naomi Carrigan <commits@nhcarrigan.com>
Co-committed-by: Naomi Carrigan <commits@nhcarrigan.com>
This commit is contained in:
2025-01-06 03:05:31 +00:00
committed by Naomi the Technomancer
parent 82d9038cdd
commit 691b5390bf
4 changed files with 610 additions and 9 deletions

View File

@ -329,10 +329,16 @@ Implement JWT-based authentication for API endpoints.
### 5.7 Testing Your Changes
- Run the linter to ensure your code complies with [our style guidelines](/dev/style).
```bash
pnpm lint # or the appropriate lint command for your project
```
- Run any existing tests to ensure your changes haven't broken anything:
```bash
pnpm test # or the appropriate test command for your project
pnpm test # or the appropriate test command for your project
```
- Add new tests for your changes if applicable.
@ -383,7 +389,8 @@ git push -u origin <branchname>
- A clear description of the changes
- The issue number(s) your pull request addresses
- Any additional context or explanations
3. If your changes include visual elements, consider adding screenshots or GIFs to illustrate the modifications.
3. Fill out the rest of the pull request form *completely*.
4. If your changes include visual elements, consider adding screenshots or GIFs to illustrate the modifications.
### 6.4 Pull Request Best Practices