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

Fixing the 'pre-commit install' command in the quick start guide of the NGF #1944

Merged
merged 2 commits into from
May 7, 2024

Conversation

sindhushiv
Copy link
Contributor

Proposed changes

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

Problem: The 'pre-commit install' command needs to be executed after the git project is created.

Solution: Moved the 'pre-commit install' command to later in the instructions, after the fork and clone instructions are executed.

Testing (optional): Verified in the documentation whether it renders correctly.

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.

Checklist

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

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • 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

Release notes

If this PR introduces a change that affects users and needs to be mentioned in the release notes,
please add a brief note that summarizes the change.


…e NGF.

Problem: The 'precommit install' command needs to be executed after the git project is created.

Solution: Moved the 'precommit install' command to later in the instructions, after the fork and clone instructions are executed.

Testing (optional): Verified in the documentation whether it renders correctly.
@sindhushiv sindhushiv requested review from a team as code owners May 7, 2024 21:50
@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 7, 2024
@sindhushiv sindhushiv enabled auto-merge (squash) May 7, 2024 21:58
@sindhushiv sindhushiv merged commit 66f763e into nginxinc:main May 7, 2024
40 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants