skypy
skypy copied to clipboard
Communication guidelines
Description
This PR is for the COMMUNICATING.md guidelines for communicating within skypy. There are a few things to discuss around this.
I'd appreciate discussion on these questions:
- Should the guidelines include a centralised method for requesting access to non-public SkyPy platforms (e.g. the Slack)?
- Does anyone have suggested information for the Google Group mailing list? @aamara I believe you set this up, can you fill in some information about how you expect it to be used?
- Does anyone have suggested information for the Google Docs/Drive? I would suggest we could structure it in some way around Draft and Archived documents
- I have avoided non-SkyPy specific information for the most part. There could be for example more general guidelines around some (about security, about the chat messages not persisting, about muting yourself) which could be included if people thought it was appropriate.
Checklist
- [x] Follow the Contributor Guidelines
- [ ] Write unit tests
- [ ] Write documentation strings
- [x] Assign someone from your working team to review this pull request
- [x] Assign someone from the infrastructure team to review this pull request
Merging this PR will close #102
Codecov Report
Merging #185 into master will not change coverage. The diff coverage is
n/a
.
@@ Coverage Diff @@
## master #185 +/- ##
=======================================
Coverage 99.04% 99.04%
=======================================
Files 20 20
Lines 521 521
=======================================
Hits 516 516
Misses 5 5
Continue to review full report at Codecov.
Legend - Click here to learn more
Δ = absolute <relative> (impact)
,ø = not affected
,? = missing data
Powered by Codecov. Last update f54960d...67cf1e7. Read the comment docs.
Great first draft @itrharrison I like the format and lots of nice ideas for content! I'll keep an updated list of my own comments here as I think of them:
- I'd prefer if the document was named
COMMUNICATION_GUIDELINES.md
. Also make skypy-board a code owner of the document here - Near the start we need something like: "All communication relating to the SkyPy project must meet the standards set out in the Code of Conduct"
- Instead of the "public" vs "private" distinction perhaps we could indicate which communication channels are available to "members" and which are available to "contributors"?
- The step-by-step instructions on how to create a new issue might be better part of the contributor guidelines? I had been thinking of adding more detail to that document relating to issues, PRs, labels, projects, milestones, assignees, reviewers etc at some point soon
- Assigning issues and linking issues to pull requests should be mentioned as ways of communicating who is working on what tasks. My opinion is that people should only be assigned to issues they are actively working on so as not to block other people from contributing. Pull requests should be opened sooner rather than later (perhaps as a draft) and always linked to an issue so that again people can see what issues are being worked on.
Looks great @itrharrison