-
Notifications
You must be signed in to change notification settings - Fork 7
Update config, README, and contributor docs #8
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
Merged
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
9a495b8
update config and readme in new template
elichad b9da23e
add code of conduct page
elichad 8105426
migrate license
elichad a80dff5
re-add and update contributor docs
elichad ffd963f
revert removal of contributor guide
elichad d87ed0a
linting fixed
elichad 1c318c0
remove beta, update url
elichad 11fd2ad
linting
elichad 9f2de36
remove unneeded lines
elichad a08b39d
move data files into episodes/, update ro-crate-preview.html
elichad e27b308
remove "about"
elichad File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # Contributor Code of Conduct | ||
|
|
||
| Contributors to the RO-Crate community, including this tutorial, are expected to comply with our [Code of Conduct](https://github.com/ResearchObject/ro-crate/blob/main/CODE_OF_CONDUCT.md) to ensure an open and inclusive environment. You may email conduct@researchobject.org to report any Code of Conduct concerns. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| # Contributing | ||
|
|
||
| [RO-Crate][roc-site] and [The Carpentries][c-site] (who provide the lesson template) | ||
| are open source projects, | ||
| and we welcome contributions of all kinds: new lessons, fixes to | ||
| existing material, bug reports, and reviews of proposed changes are all | ||
| welcome. | ||
|
|
||
| ## Contributor Agreement | ||
|
|
||
| By contributing, you agree that we may redistribute your work under [our | ||
| license](LICENSE.md). In exchange, we will address your issues and/or assess | ||
| your change proposal as promptly as we can, and help you become a member of our | ||
| community. Everyone involved in [RO-Crate][roc-site] agrees to abide by our | ||
| [code of conduct](CODE_OF_CONDUCT.md). | ||
|
|
||
| ## How to Contribute | ||
|
|
||
| The easiest way to get started is to file an issue to tell us about a spelling | ||
| mistake, some awkward wording, or a factual error. This is a good way to | ||
| introduce yourself and to meet some of our community members. | ||
|
|
||
| 1. If you do not have a [GitHub][github] account, you can [send us comments by | ||
| email][roc-contact]. However, we will be able to respond more quickly if you use | ||
| one of the other methods described below. | ||
|
|
||
| 2. If you have a [GitHub][github] account, or are willing to [create | ||
| one][github-join], but do not know how to use Git, you can report problems | ||
| or suggest improvements by [creating an issue][repo-issues]. This allows us | ||
| to assign the item to someone and to respond to it in a threaded discussion. | ||
|
|
||
| 3. If you are comfortable with Git, and would like to add or change material, | ||
| you can submit a pull request (PR). Instructions for doing this are | ||
| [included below](#using-github). For inspiration about changes that need to | ||
| be made, check out the [list of open issues][issues] across the Carpentries. | ||
|
|
||
| Note: if you want to build the website locally, please refer to [The Workbench | ||
| documentation][template-doc]. | ||
|
|
||
| ## Where to Contribute | ||
|
|
||
| 1. If you wish to change this lesson, add issues and pull requests here. | ||
| 2. If you wish to change the template used for workshop websites, please refer | ||
| to [The Workbench documentation][template-doc]. | ||
|
|
||
| ## What to Contribute | ||
|
|
||
| There are many ways to contribute, from writing new exercises and improving | ||
| existing ones to updating or filling in the documentation and submitting [bug | ||
| reports][issues] about things that do not work, are not clear, or are missing. | ||
| If you are looking for ideas, please see [the list of issues for this | ||
| repository][repo-issues], or the issues for [Data Carpentry][dc-issues], | ||
| [Library Carpentry][lc-issues], and [Software Carpentry][swc-issues] projects. | ||
|
|
||
| Comments on issues and reviews of pull requests are just as welcome: we are | ||
| smarter together than we are on our own. **Reviews from novices and newcomers | ||
| are particularly valuable**: it's easy for people who have been using these | ||
| lessons for a while to forget how impenetrable some of this material can be, so | ||
| fresh eyes are always welcome. | ||
|
|
||
| ## What *Not* to Contribute | ||
|
|
||
| Our lessons already contain more material than we can cover in a typical workshop, | ||
| so we are usually *not* looking for more concepts or tools to add to them. | ||
| As a rule, | ||
| if you want to introduce a new idea, | ||
| you must (a) estimate how long it will take to teach | ||
| and (b) explain what you would take out to make room for it. | ||
| The first encourages contributors to be honest about requirements; | ||
| the second, to think hard about priorities. | ||
|
|
||
| We are also not looking for exercises or other material that only run on one platform. | ||
| Our workshops typically contain a mixture of Windows, macOS, and Linux users; | ||
| in order to be usable, | ||
| our lessons must run equally well on all three. | ||
|
|
||
| ## Using GitHub | ||
|
|
||
| If you choose to contribute via GitHub, you may want to look at [How to | ||
| Contribute to an Open Source Project on GitHub][how-contribute]. In brief, we | ||
| use [GitHub flow][github-flow] to manage changes: | ||
|
|
||
| 1. Create a new branch in your desktop copy of this repository for each | ||
| significant change. | ||
| 2. Commit the change in that branch. | ||
| 3. Push that branch to your fork of this repository on GitHub. | ||
| 4. Submit a pull request from that branch to the [upstream repository][repo]. | ||
| 5. If you receive feedback, make changes on your desktop and push to your | ||
| branch on GitHub: the pull request will update automatically. | ||
|
|
||
| NB: The published copy of the lesson is usually in the `main` branch. | ||
|
|
||
| Each lesson has a team of maintainers who review issues and pull requests or | ||
| encourage others to do so. The maintainers are community volunteers, and have | ||
| final say over what gets merged into the lesson. | ||
|
|
||
| ## Other Resources | ||
|
|
||
| General discussion of [RO-Crate][roc-site] happens on the | ||
| [RO-Crate GitHub repository](https://github.com/ResearchObject/ro-crate) and in our | ||
| [community spaces](https://www.researchobject.org/ro-crate/community), | ||
| which everyone is welcome to join. | ||
| You can also [reach us by email][roc-contact]. | ||
|
|
||
| The Carpentries is a global organisation with volunteers and learners all over | ||
| the world. We share values of inclusivity and a passion for sharing knowledge, | ||
| teaching and learning. There are several ways to connect with The Carpentries | ||
| community listed at <https://carpentries.org/connect/> including via social | ||
| media, slack, newsletters, and email lists. You can also [reach us by | ||
| email][cp-contact]. | ||
|
|
||
|
|
||
| [roc-contact]: mailto:ro-crate@researchobject.org | ||
| [roc-site]: https://www.researchobject.org/ro-crate/ | ||
| [repo]: https://github.com/ResearchObject/packaging_data_with_ro-crate | ||
| [repo-issues]: https://github.com/ResearchObject/packaging_data_with_ro-crate/issues | ||
| [cp-contact]: mailto:team@carpentries.org | ||
| [cp-site]: https://carpentries.org/ | ||
| [dc-issues]: https://github.com/issues?q=user%3Adatacarpentry | ||
| [dc-lessons]: https://datacarpentry.org/lessons/ | ||
| [dc-site]: https://datacarpentry.org/ | ||
| [discuss-list]: https://carpentries.topicbox.com/groups/discuss | ||
| [github]: https://github.com | ||
| [github-flow]: https://guides.github.com/introduction/flow/ | ||
| [github-join]: https://github.com/join | ||
| [how-contribute]: https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github | ||
| [issues]: https://carpentries.org/help-wanted-issues/ | ||
| [lc-issues]: https://github.com/issues?q=user%3ALibraryCarpentry | ||
| [swc-issues]: https://github.com/issues?q=user%3Aswcarpentry | ||
| [swc-lessons]: https://software-carpentry.org/lessons/ | ||
| [swc-site]: https://software-carpentry.org/ | ||
| [lc-site]: https://librarycarpentry.org/ | ||
| [template-doc]: https://carpentries.github.io/workbench/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| --- | ||
| layout: page | ||
| title: "Licenses" | ||
| root: . | ||
| --- | ||
|
|
||
| # Training Materials | ||
|
|
||
| © Copyright 2021-2025 University of Technology Sydney, The University of Manchester UK and RO-Crate contributors. | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. | ||
|
|
||
| ## Changes | ||
|
|
||
| This tutorial has been adapted from the revised [RO-Crate introduction for 1.2](https://www.researchobject.org/ro-crate/1.2-DRAFT/introduction.html) by Stian Soiland-Reyes. Changes include: | ||
| * Rewriting to tutorial style with exercises | ||
| * Adaptation to Galaxy Training Material rendering | ||
| * Explicit links to RO-Crate specifications | ||
| * Example changed to different organization and license | ||
| * Modiied for Carpentries style | ||
|
|
||
| # Examples | ||
|
|
||
| The RO-Crate JSON-LD examples and solutions are distributed under [CC0 1.0 Universal (CC0 1.0) Public Domain Dedication](https://creativecommons.org/publicdomain/zero/1.0/). This means they can be re-used freely without any requirements for attribution or licence. | ||
|
|
||
|
|
||
| # Trademarks | ||
|
|
||
| "Software Carpentry" and "Data Carpentry" and their respective logos | ||
| are registered trademarks of [Community Initiatives][CI]. | ||
|
|
||
| [ci]: http://communityin.org/ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note the warning from GH actions that this should be in the form text
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ignoring the warning as this block is using the boilerplate taken from How to apply the Apache License to your work