generated from carpentries/workbench-template-md
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
17 additions
and
37 deletions.
There are no files selected for viewing
This file contains 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 |
---|---|---|
@@ -1,27 +1,19 @@ | ||
## Contributing | ||
|
||
[The Carpentries][cp-site] ([Software Carpentry][swc-site], [Data | ||
Carpentry][dc-site], and [Library Carpentry][lc-site]) 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. | ||
You are welcome to contribute to the content of this lesson. | ||
|
||
### 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 [The Carpentries][cp-site] agrees to abide by | ||
our [code of conduct](CODE_OF_CONDUCT.md). | ||
license](LICENSE.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][contact]. However, we will be able to respond more quickly if you use | ||
1. If you do not have a [GitHub][github] account, you can [send us comments trhrough workshop chat][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 | ||
|
@@ -48,10 +40,9 @@ documentation][template-doc]. | |
|
||
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. | ||
reports][repo-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. | ||
repository][repo-issues]. | ||
|
||
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 | ||
|
@@ -95,29 +86,18 @@ final say over what gets merged into the lesson. | |
|
||
### Other Resources | ||
|
||
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, | ||
The lesson uses a [template][template-doc] from The Carpentries. It is a global organisation with volunteers and learners all over | ||
the world. It shares 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][contact]. | ||
|
||
[repo]: https://example.com/FIXME | ||
[repo-issues]: https://example.com/FIXME/issues | ||
[contact]: mailto:[email protected] | ||
[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/ | ||
media, slack, newsletters, and email lists. | ||
|
||
[repo]: https://github.com/cms-opendata-workshop/workshopqcd-2024-lesson-dataset-scouting/ | ||
[repo-issues]: https://github.com/cms-opendata-workshop/workshopqcd-2024-lesson-dataset-scouting/issues | ||
[contact]: https://mattermost.web.cern.ch/midsummerqcd2024/channels/hands-on-sessions | ||
[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 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 |
---|---|---|
@@ -1,8 +1,7 @@ | ||
--- | ||
title: 'Reference' | ||
title: Glossary | ||
--- | ||
|
||
## Glossary | ||
|
||
This is a placeholder file. Please add content here. | ||
Feel free to suggest contents to the glossary. | ||
See [how to contribute](https://github.com/cms-opendata-workshop/workshopqcd-2024-lesson-docker/blob/main/CONTRIBUTING.md). | ||
|
This file contains 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