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 developer guide to CONTRIBUTING.md #669

Merged
merged 22 commits into from
May 30, 2023

Conversation

kate-osborn
Copy link
Contributor

@kate-osborn kate-osborn commented May 23, 2023

Adds the following developer docs:

  • Quickstart
  • Branching and Workflow
  • Implement a Feature
  • Testing
  • Pull Request Guidelines

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

Closes #670

@kate-osborn kate-osborn requested a review from a team as a code owner May 23, 2023 20:30
@github-actions github-actions bot added chore Pull requests for routine tasks documentation Improvements or additions to documentation labels May 23, 2023
Copy link
Contributor

@pleshakov pleshakov left a comment

Choose a reason for hiding this comment

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

great stuff overall 👍

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
docs/developer/branching-and-workflow.md Show resolved Hide resolved
docs/developer/branching-and-workflow.md Outdated Show resolved Hide resolved
docs/developer/branching-and-workflow.md Outdated Show resolved Hide resolved
docs/developer/pull-request.md Outdated Show resolved Hide resolved
docs/developer/implementing-a-feature.md Outdated Show resolved Hide resolved
docs/developer/testing.md Outdated Show resolved Hide resolved
docs/developer/testing.md Outdated Show resolved Hide resolved
docs/developer/testing.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
docs/developer/branching-and-workflow.md Show resolved Hide resolved
docs/developer/implementing-a-feature.md Outdated Show resolved Hide resolved
docs/developer/pull-request.md Outdated Show resolved Hide resolved
docs/developer/testing.md Outdated Show resolved Hide resolved
@kate-osborn kate-osborn mentioned this pull request May 24, 2023
6 tasks
@kate-osborn kate-osborn removed the chore Pull requests for routine tasks label May 24, 2023
@github-actions github-actions bot added the chore Pull requests for routine tasks label May 25, 2023
Copy link
Contributor

@pleshakov pleshakov left a comment

Choose a reason for hiding this comment

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

👍

@kate-osborn kate-osborn merged commit 5fbfb7c into nginxinc:main May 30, 2023
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Pull requests for routine tasks documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add developer guide to CONTRIBUTING.md
4 participants