add contributing md #731
add contributing md #731
Conversation
|
No broken urls! 🎉 |
|
Re-rendered previews from the latest commit:
* note not all html features will be properly displayed in the "quick preview" but it will give you a rough idea. Updated at 2024-03-14 with changes from the latest commit c12d58a |
|
No spelling! 🎉 |
There was a problem hiding this comment.
@kweav This is excellent and something that has been long overdue. Really glad you could contribute this contributing guide 😄 .
I only have very minor suggestions so after you work on incorporating these suggestions I don't feel a need to re-review, just merge it after you incorporate the changes.
Thanks!
CONTRIBUTING.md
Outdated
|
|
||
| #### Wiki | ||
|
|
||
| Listed as the "main OTTR guide" on some READMEs, there's an [OTTR wiki](https://github.com/jhudsl/OTTR_Template/wiki). |
There was a problem hiding this comment.
Ah yes. We've been working on slowly deprecating this and will archive it eventually. Is there anywhere you found that is still pointing to this wiki? If so we should get rid of those and also not mention it in this CONTRIBUTING.md guide. Thanks.
There was a problem hiding this comment.
Removed in commit 5208345. Will remove from ottrpal README.
There was a problem hiding this comment.
Removed from ottrpal README in commit bb3bb6c
| | OTTR_Template_Website | [Open an issue here](https://github.com/jhudsl/OTTR_Template_Website/issues/new/choose)| | ||
| | ottr-reports | [Open an issue here](https://github.com/jhudsl/ottr-reports/issues/new/choose) | | ||
| | ottrpal | [Open an issue here](https://github.com/jhudsl/ottrpal/issues/new/choose) | | ||
| | cow | [Open an issue here](https://github.com/jhudsl/cow/issues/new/choose) | |
There was a problem hiding this comment.
My goal is that we eventually deprecate cow and have its useful functions absorbed by ottrpal, but I haven't had time to do this. If this is something you'd be interested in doing, happy to have you take this one. Up to you.
|
|
||
| If you plan to use the OTTR template several times for related courses within an organization and want each to have a shared branding or functionality variation, you may want to make your own template from the OTTR_Template, incorporating the stylistic changes in your spinoff template before making specific courses from the spinoff template. | ||
|
|
||
| OTTR_Template --> Spinoff_Template (Make stylistic changes, mark as a template repository) --> Course Repository |
CONTRIBUTING.md
Outdated
|
|
||
| ## Code of Conduct | ||
|
|
||
| The [Contributor Covenant Code of Conduct can be found here](https://github.com/jhudsl/OTTR_Template/blob/main/code_of_conduct.md) |
There was a problem hiding this comment.
This should probably be brought to the top so people are aware of it sooner.
There was a problem hiding this comment.
Moved in commit 5208345
Co-authored-by: Candace Savonen <[email protected]>
Co-authored-by: Candace Savonen <[email protected]>
Co-authored-by: Candace Savonen <[email protected]>
Co-authored-by: Candace Savonen <[email protected]>
Purpose/implementation Section
What changes are being implemented in this Pull Request?
Adding a
CONTRIBUTING.mdfile and adding it to the list of template specific files that needs to be cleaned up for course setupWhat was your approach?
Added the markdown file and included it in the list of files that needed to be cleaned up in
starting-course.ymlWhat GitHub issue does your pull request address?
Issue #706
Tell potential reviewers what kind of feedback you are soliciting.
Does this cover what you were hoping for? What information isn't there but should be? What information is there but shouldn't be? What information needs to be clearer?