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

Initial code considerations and other sections #5

Merged
merged 9 commits into from
Jan 30, 2021

Conversation

KodrAus
Copy link
Contributor

@KodrAus KodrAus commented Jan 29, 2021

Contributes to #1 and #3

This is a large drop of our existing forge docs that's been re-organized into a Code considerations section. It's got a stubbed out reviewer checklist too that we could try turn into a friendly document that reviewers can refer to when PRs come along.

I've also stubbed out a Lifecycle of a feature section where we can talk about new unstable APIs, tracking issues, stabilizations, and deprecations.

It's all still very rough 🙂 But should give us space to start capturing more code guidelines and start documenting our processes.

r? @m-ou-se @Mark-Simulacrum

@KodrAus KodrAus changed the title Feat/code considerations Initial code considerations and other sections Jan 29, 2021
@KodrAus
Copy link
Contributor Author

KodrAus commented Jan 29, 2021

Also cc @jyn514 and @camelid who've expressed an early interest in the std dev guide.

@KodrAus
Copy link
Contributor Author

KodrAus commented Jan 29, 2021

The process sections are still very sparse, but we should be able to fill them out pretty well.

Copy link
Member

@m-ou-se m-ou-se left a comment

Choose a reason for hiding this comment

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

Nice! Looking forward to filling out all this stuff more. :)

src/tools-and-bots/crater.md Outdated Show resolved Hide resolved
@KodrAus
Copy link
Contributor Author

KodrAus commented Jan 30, 2021

I'll go ahead and merge this in then so we can start working on it!

@KodrAus KodrAus merged commit 8583740 into master Jan 30, 2021
@KodrAus KodrAus deleted the feat/code-considerations branch January 30, 2021 13:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants