Task #10030 (closed)
Opened 11 years ago
Closed 10 years ago
Docs: Add contributing.md to all repositories.
| Reported by: | jamoore | Owned by: | hflynn |
|---|---|---|---|
| Priority: | minor | Milestone: | 5.x |
| Component: | Documentation | Version: | 4.4.8 |
| Keywords: | n.a. | Cc: | omero-team@… |
| Resources: | n.a. | Referenced By: | n.a. |
| References: | n.a. | Remaining Time: | n.a. |
| Sprint: | n.a. |
Description
See: https://github.com/blog/1184-contributing-guidelines
A decision would need to be made about how much of the existing documentation should be moved to this file, or if just a link should be provided:
Change History (6)
comment:1 Changed 11 years ago by mlinkert
- Owner changed from hfylnn to hflynn
- Version set to 4.4.8
comment:2 Changed 11 years ago by hflynn
comment:3 Changed 11 years ago by jamoore
Helen, happy to talk whenever. Having a small blurb and a link is certainly fine in most if not all cases. Perhaps a link to our upcoming "contributing" section along with the main developers landing page for that particular repository? Mailing lists? Not sure.
Eventually (perhaps another ticket) something like https://github.com/puppetlabs/puppet/blob/master/CONTRIBUTING.md 's link to https://cla.puppetlabs.com/ would be beneficial.
comment:4 Changed 10 years ago by hflynn
- Status changed from new to accepted
Added to the main openmicroscopy repo, will open PRs to add similar content to the docs repo and BF.
comment:5 Changed 10 years ago by hflynn
see https://github.com/openmicroscopy/ome-documentation/pull/757. I'll open another PR for BF tomorrow.
comment:6 Changed 10 years ago by hflynn
- Resolution set to fixed
- Status changed from accepted to closed
Ok, docs version merged and rebased. BF version now open https://github.com/openmicroscopy/bioformats/pull/1072
I'm assuming we only need them on the 3 main repos, the rest are varying degrees of internal to my mind. So closing as fixed. @jamoore will leave you to reopen if you want them added elsewhere but might also be more appropriate to reassign in that case.
@jamoore - we should probably have a chat about this. I wonder if the best option for BF would be to just add a link to the developers index page to the readme (which I notice only talks about supported formats under the developer section at the moment) labelled as contributing guidelines/information. Is it worth adding another page just to do that?
For OMERO, not sure how this fits in with #11186 but again, I wonder if the existing readme isn't the best place for such links. I certainly don't think we should start reproducing developer guidelines in yet another location!