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

Add Go style guide #679

Merged
merged 8 commits into from
May 30, 2023
Merged

Conversation

kate-osborn
Copy link
Contributor

Proposed changes

This PR adds a style guide for Go. Once #669 is merged, I will add a link to this doc in CONTRIBUTING.md.

Closes #671

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

@kate-osborn kate-osborn requested a review from a team as a code owner May 24, 2023 21:23
@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 24, 2023
@kate-osborn kate-osborn requested review from pleshakov and sjberman May 25, 2023 16:59
docs/developer/go-style-guide.md Outdated Show resolved Hide resolved
docs/developer/go-style-guide.md Show resolved Hide resolved
docs/developer/go-style-guide.md Outdated Show resolved Hide resolved
docs/developer/go-style-guide.md Outdated Show resolved Hide resolved
@kate-osborn kate-osborn requested review from sjberman and ciarams87 May 25, 2023 19:09
Copy link
Contributor

@ciarams87 ciarams87 left a comment

Choose a reason for hiding this comment

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

👍🏼

docs/developer/go-style-guide.md Show resolved Hide resolved
docs/developer/go-style-guide.md Outdated Show resolved Hide resolved
@kate-osborn kate-osborn force-pushed the docs/code-style-guide branch from 4e6c451 to 8afdf89 Compare May 30, 2023 21:18
@kate-osborn kate-osborn requested a review from pleshakov May 30, 2023 21:20
@kate-osborn kate-osborn merged commit 8195442 into nginx:main May 30, 2023
miledxz added a commit to miledxz/nginx-gateway-fabric that referenced this pull request Jan 14, 2025
Problem: The project's coding style guidelines are undocumented.

Solution: Add a Go style guide to the developer docs and link to it 
in the developer guide and the implementing a feature guide.
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
None yet
Development

Successfully merging this pull request may close these issues.

Add code style guide
4 participants