Update Documentation Guidelines#188
Conversation
Signed-off-by: Alex Le <alex.le@improving.com>
Signed-off-by: Alex Le <alex.le@improving.com>
Signed-off-by: Alex Le <alex.le@improving.com>
Signed-off-by: Alex Le <alex.le@improving.com>
Signed-off-by: Alex Le <alex.le@improving.com>
|
|
||
| <!-- | ||
| Describe what tests have been conducted (e.g., build verification, link checking, visual review) | ||
| Required. Please list the changes you have made, preferrably in bullet point forms. |
There was a problem hiding this comment.
nit: Typo, should be "preferably".
|
|
||
| - **Update the sidebar navigation:** Add your new page to `astro.config.mjs`. | ||
|
|
||
| For a guidelines on how to write new articles, take a look at our [Contributing](/CONTRIBUTING.md) page. |
There was a problem hiding this comment.
nit: Typo, should be "For guidelines".
| - [ ] This Pull Request is related to one issue. | ||
| - [ ] Commit message has a detailed description of what changed and why. | ||
| - [ ] All commits are signed off with `--signoff` flag. | ||
| - [ ] `pnpm build` runs successfully. |
There was a problem hiding this comment.
May want to keep a minimal checklist, including pnpm build, pnpm format:check, commits are signed off, etc.
There was a problem hiding this comment.
I added back into 2 points. But I deally I think these should already be enfornced by our CI
There was a problem hiding this comment.
Could add more info on how to contribute, such as:
- Fork repo and create PR to this repo
- DCO/commit signoff
pnpm buildandpnpm format:check(already mentioned in README, but also should be mentioned quickly here too I think)
There was a problem hiding this comment.
What's usually expected in the contributing doc?
There was a problem hiding this comment.
Depends on the repo, I was just thinking of mandatory items someone needs for their PR to pass inspection and be merged. Some overlap with the template checklist and what CI enforces, but good for devs to see the list in CONTRIBUTING so they can read before they create a PR.
| @@ -1,47 +1,19 @@ | |||
| <!-- | |||
| Thanks for contributing to Valkey GLIDE Documentation! | |||
There was a problem hiding this comment.
I would suggest to keep this comment block in the template but adjust to use the CONTRIBUTING.md you created.
Signed-off-by: Alex Le <alex.le@improving.com>
Signed-off-by: Alex Le <alex.le@improving.com>
Signed-off-by: Alex Le <alex.le@improving.com>
3 participants
Summary
This PR updates the pull request templates, readme and contributing docs.