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

[docs] Cleanup docs for new contributors #377

Closed
haworku opened this issue Aug 3, 2020 · 1 comment · Fixed by #402
Closed

[docs] Cleanup docs for new contributors #377

haworku opened this issue Aug 3, 2020 · 1 comment · Fixed by #402
Assignees
Labels
type: documentation Improvements or additions to documentation

Comments

@haworku
Copy link
Contributor

haworku commented Aug 3, 2020

We have started getting outside pull requests 🎉 . This is great and let's clean up things a bit.

  • Separate the releasing guide from contributing guide.
  • Improve contributing guide to more clearly highlight how external PRs will be merged (currently we have to replicate work to a new branch for CI runs, eventually we have automation for this).
  • Double check accuracy, readability of contributing guide and PR template in general.
@haworku haworku added the type: documentation Improvements or additions to documentation label Aug 3, 2020
@jim
Copy link
Contributor

jim commented Aug 13, 2020

We could move the checklist part of the PR template into a section (instead of a comment at the beginning) so that the list is visible in PRs by default. I think showing it at the beginning in a comment can be confusing- what are we expecting folks to do with it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants