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

First pass at revamping docs #1458

Merged
merged 3 commits into from
Apr 20, 2024
Merged

Conversation

damccorm
Copy link
Contributor

@damccorm damccorm commented Apr 19, 2024

Add folder dedicated for contributor docs and (a) move a bunch of info there, and (b) add some new content

My goal here is mostly to get the process started so that we can improve over time.

Part of #1459

CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Contributor

@liferoad liferoad left a comment

Choose a reason for hiding this comment

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

Looks great! Left some minor changes.
One last question: shall we create a developer guide to show how to add a new template or integration tests, etc?

Copy link
Contributor Author

@damccorm damccorm left a comment

Choose a reason for hiding this comment

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

One last question: shall we create a developer guide to show how to add a new template or integration tests, etc?

My plan is to build out docs on code contributions to have more information (and maybe split some pieces out further). I'd like to scope that to a future PR though; I'll track things with #1459

CONTRIBUTING.md Outdated Show resolved Hide resolved
contributor-docs/code-contributions.md Outdated Show resolved Hide resolved
contributor-docs/code-contributions.md Show resolved Hide resolved
contributor-docs/code-owners.md Show resolved Hide resolved
@damccorm damccorm requested a review from liferoad April 20, 2024 14:00
Copy link
Contributor

@liferoad liferoad left a comment

Choose a reason for hiding this comment

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

Thanks.

@liferoad liferoad added the Google LGTM Approval of a pull request to be merged into the repository label Apr 20, 2024
@copybara-service copybara-service bot merged commit 1aa979e into main Apr 20, 2024
6 checks passed
@damccorm damccorm deleted the users/damccorm/contributionDocs branch April 20, 2024 19:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Google LGTM Approval of a pull request to be merged into the repository size/XXL
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants