Contributing Docs
These are doc ideas for contributing docs. Can/should these go to MKDocs? These are across all repos.
-
Ensure CONTRIBUTING.md in all repos. (Christine) -
In the language for contributions, encourage that here are the rules. If you find a violation of the rules, speak up. (I wouldn't use 'rule'.) -
Ensure that all repos have the same 'I put my stuff into the public domain' acceptance block. (Austin - PRs in individual repos) -
How to: pull the code, make a change, update tests, push a PR. (Jacob) -
Maybe how to convert an ISIS app to a callable? (Austin -- already written on docs repo? how-to-guides/ISIS%20Developer%20Guides/Writing%20ISIS%20Tests%20with%20CTest%20and%20GTest/) -
PR size with examples, e.g., a single thematic idea. Not a hard cap, but a 'single entry' in the change log? (Austin) -
Test writing: ISIS, usgscsm, knoten, etc. -
ISIS -
ALE (including kernel slicing) (Austin) -
PyTests (USGSCSM etc.)
-
-
Where are the test data, how do you pull them, how do you add data, what are the restrictions? - Can use this as a starting point, but needs to be updated https://github.com/DOI-USGS/ISIS3/wiki/Test-Data-Obtaining,-Maintaining,-and-Submitting
-
Example(s) on how we want CHANGELOG entries working. (Austin) -
Documentation expectations with PRs? -
Adopt a standard template for contributions? Check boxes for compliance as defined? -
Take this time to update / codify the release timeline on all these repos. This way contributors know when their change(s) will land. -
Contributing via issues: maybe see here?(provided on docs repo at how-to-guides/software-management/guidelines-for-reporting-issues/)
For ISIS specifically:
-
what are the types of PRs (bug vs. enhancement) and where will they land in the code base. -
Information on the direction of the code base - what types of enhancements are explicitly not being solicited? If I have an idea, for a feature, can we give general docs on what is in and out of scope?
Specific to docs:
-
Do we have a template for Getting Started (e.g., this is what you will learn, these are the dependencies, etc.) -
How does one contribute to the docs?
Edited by Sanders, Austin Ray