Skip to content

docs: Update CONTRIBUTING_DOCS.md #402

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

Merged
merged 3 commits into from
Apr 15, 2025
Merged

docs: Update CONTRIBUTING_DOCS.md #402

merged 3 commits into from
Apr 15, 2025

Conversation

JTorreG
Copy link
Contributor

@JTorreG JTorreG commented Apr 14, 2025

Update the contributing to docs file to clarify ref and relref usage

Proposed changes

Write a clear and concise description that helps reviewers understand the purpose and impact of your changes. Use the
following format:

Problem: Give a brief overview of the problem or feature being addressed.

Solution: Explain the approach you took to implement the solution, highlighting any significant design decisions or
considerations.

Testing: Describe any testing that you did.

Please focus on (optional): If you any specific areas where you would like reviewers to focus their attention or provide
specific feedback, add them here.

If this PR addresses an issue on GitHub, ensure that you link to it here:

Closes #ISSUE

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes1, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md and CHANGELOG.md

Footnotes

  1. Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content.

Update the contributing to docs file to clarify ref and relref usage
@JTorreG JTorreG self-assigned this Apr 14, 2025
@github-actions github-actions bot added the process documentation Documentation related to how the repository or documention itself is managed. label Apr 14, 2025
@JTorreG JTorreG marked this pull request as ready for review April 14, 2025 13:57
@JTorreG JTorreG requested a review from a team as a code owner April 14, 2025 13:57
@JTorreG JTorreG mentioned this pull request Apr 14, 2025
Copy link

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/402/

Copy link
Contributor

@mjang mjang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With a suggestion

@ADubhlaoich ADubhlaoich enabled auto-merge (squash) April 15, 2025 09:42
@ADubhlaoich ADubhlaoich merged commit eba6dbf into main Apr 15, 2025
5 checks passed
@ADubhlaoich ADubhlaoich deleted the JTorreG-patch-1 branch April 15, 2025 09:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
process documentation Documentation related to how the repository or documention itself is managed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants