Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Clarify CONTRIBUTING_DOCS #22

Merged
merged 1 commit into from
Dec 10, 2024
Merged

fix: Clarify CONTRIBUTING_DOCS #22

merged 1 commit into from
Dec 10, 2024

Conversation

mjang
Copy link
Collaborator

@mjang mjang commented Dec 9, 2024

Proposed changes

Problem: The CONTRIBUTING_DOCS.md file is not clear in its descriptions of the make drafts command.

Solution: Clarify the description.

Testing: n/a

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the contributing guidelines.
  • I have signed the F5 Contributor License Agreement (CLA).
  • If applicable, I have added tests that prove my fix is effective or that my feature works.
  • If applicable, I have checked that any relevant tests pass after adding my changes.
  • I have updated any relevant documentation (README.md and CHANGELOG.md).
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork
  • If the change involves:
    • Code
    • Anything that resembles Personally identifying information (PII)
    • URLs
    • Significant new/revised content
      The change will require at least two (2) approvals before merging. One requirement: use placeholders such as <JWT Token> in place of PII

@mjang mjang self-assigned this Dec 9, 2024
@mjang mjang requested a review from a team as a code owner December 9, 2024 19:47
CONTRIBUTING_DOCS.md Outdated Show resolved Hide resolved
* Reorder make commands. `make watch` is preferred
* Update Hugo version
* Co-authored-by: Alan Dooley <[email protected]>
@mjang mjang force-pushed the fix-mjang-contributing-docs branch from 7be41f0 to 3227022 Compare December 10, 2024 14:49
@mjang mjang merged commit c1fd8a3 into main Dec 10, 2024
1 check failed
@mjang mjang deleted the fix-mjang-contributing-docs branch December 11, 2024 13:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants