├── CONTRIBUTING.md └── README.md /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | ## Contributing 2 | 3 | **Library Carpentry** is an open source project. It was created initially by [Dr James Baker](https://github.com/drjwbaker), with 4 | contributions from [Owen Stephens](https://github.com/ostephens) and [Daniel van Strien](https://github.com/davanstrien), and was forked here in 2016 to facilitate further development during the Mozilla Science Lab Global Sprint, 2-3 June, 2016. 5 | 6 | Details of what we achieved in that sprint can be found in this [blog post](https://software-carpentry.org/blog/2016/06/library-carpentry-sprint.html). The Library Carpentry community is now global, with a very active core of instructors and lesson maintainers. 7 | We used this fork again for work on the 2017 Mozilla Science Lab Global Sprint, which took place on 1-2 June, 2017. 8 | 9 | We will now use it for the 218 sprint. 10 | 11 | Attendees should be aware of, and comply with the [Mozilla Community Participation Guidelines](https://www.mozilla.org/en-US/about/governance/policies/participation/). Sprint attendees, whether attending remotely, or at an in-person site, must abide by the [Software and Data Carpentry Code of Conduct](http://www.datacarpentry.org/code-of-conduct/). 12 | 13 | In this fork, we welcome contributions of all kinds: new lessons, additions to existing materials, fixes for errors, 14 | and bug reports. 15 | 16 | By contributing, you agree that we may redistribute your work under our license. In exchange, 17 | you will be contributing to the development of this material for the library community worldwide. 18 | While this is not an official Software Carpentry set of lessons or project, participants should abide by the Software 19 | Carpentry [Code of Conduct](http://software-carpentry.org/conduct/). 20 | 21 | See more about the initial Library Carpentry project [here](https://github.com/LibraryCarpentry). 22 | 23 | For more up to date information, including all the work we have done since the very successful 24 | 2016 sprint, see [our main page](https://librarycarpentry.github.io/). 25 | 26 | ## What We're Looking For 27 | 28 | There are many ways to contribute, from writing new exercises and challenge tasks to improving existing ones, 29 | or adapting them for different datasets. You are also welcome to point out typos, factual errors, and inconsistencies. 30 | 31 | You do not need to be a coder to take part. Librarians are welcome to raise issues, contribute examples, ask questions, request that scenarios be addressed and so on. You can also work through the lessons and ask for clarification or further explanation or documentation. 32 | 33 | All input is useful. 34 | 35 | Reviews of pull requests are welcome: we want this material to be accessible and useful, so your views on 36 | what has been added or changed will be of benefit. if you are not sure how to fix something, please raise an issue 37 | on the appropriate repository, and the maintainers will try to address it. 38 | 39 | ## What We're Not Looking For 40 | 41 | We are not looking for exercises or material that can only run on 42 | one platform. Attendees at workshops may be Windows, Mac OS X, or Linux users. Lessons must run 43 | equally well on all three to be useful. 44 | 45 | ## Getting Started 46 | 47 | If you want to start adding or editing material yourself, you may want to look at 48 | [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github). In brief: 49 | 50 | 1. Create a new branch in your desktop copy of this repository for each significant change. 51 | 2. Commit the change in that branch. 52 | 3. Push that branch to your fork of this repository on GitHub. 53 | 4. Submit a pull request from that branch to the master repository. 54 | 5. If you receive feedback, make changes locally and push to your branch on GitHub: 55 | the pull request will update automatically. 56 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## Materials for Library Carpentry development 2 | 3 | Many of these materials are based on the **Library Carpentry** materials initially developed and taught by [Dr James Baker](https://github.com/drjwbaker), [Owen Stephens](https://github.com/ostephens) and [Daniel van Strien](https://github.com/davanstrien) in the UK. 4 | [http://librarycarpentry.github.io/outline/](http://librarycarpentry.github.io/outline/). The original Library Carpentry contained four modules: 5 | - Introduction, including jargon busting, data structures and regular expressions 6 | - The Unix shell, including use of the command line and commands such as`grep` and `sed` to find data within files 7 | - Git and version control 8 | - Using OpenRefine for data clean up. 9 | 10 | These four repositories have been re-developed within the GitHub `data-lessons` area, and new lessons have been added. All lessons are open to contributions, whether through pull requests or through issues raised on the repositories themselves. 11 | 12 | ## Lessons 13 | 14 | Library Carpentry prides itself on reviewing and revising our lessons to ensure that they fit the needs and requirements of the communities we serve. As a result our lessons are at varying stages of maturity. 15 | 16 | Our **Core** lessons - those which we are confident that anyone can teach with no problems - are: 17 | 18 | - [library-data-intro](https://github.com/librarycarpentry/lc-data-intro) 19 | - [library-shell](https://github.com/librarycarpentry/lc-shell) 20 | - [library-openrefine](https://github.com/librarycarpentry/lc-open-refine) 21 | 22 | Our **Beta** lessons - those which need to be taught more to iron out their content and flow - are: 23 | 24 | - [library-git](https://github.com/librarycarpentry/lc-git) 25 | - [library-python-intro](https://github.com/librarycarpentry/lc-python-intro) 26 | - [library-sql](https://github.com/librarycarpentry/lc-sql) 27 | 28 | Our **Alpha** lessons - those which are new or substantially revised and have therefore yet to be tested in a teaching environment - are: 29 | 30 | - [library-python](https://github.com/data-lessons/library-python) 31 | - [library-webscraping](https://github.com/librarycarpentry/lc-webscraping) 32 | - [library-spreadsheets](https://github.com/librarycarpentry/lc-spreadsheets) 33 | - [data-intro-archives](https://github.com/data-lessons/data-intro-archives) 34 | 35 | If you plan to teach an **Alpha** or **Beta** status lesson at a Library Carpentry workshop, we recommend you contact the lesson's maintainer (listed in the lesson README.md file) before doing so. 36 | 37 | A lot of work was done on the repositories during the recent Mozilla Global sprint. For work outstanding, please see the [issues here](https://github.com/data-lessons/librarycarpentry/issues). Contributions welcome. 38 | 39 | ## License 40 | 41 | *Library Carpentry builds on the work of [Software 42 | Carpentry]({{site.swc_site}}) and [Data 43 | Carpentry]({{site.dc_site}}). It uses the same license as these 44 | projects. This can be found below.* 45 | 46 | ### Instructional Material 47 | 48 | All Software Carpentry and Data Carpentry instructional material is 49 | made available under the [Creative Commons Attribution 50 | license][cc-by-human]. The following is a human-readable summary of 51 | (and not a substitute for) the [full legal text of the CC BY 4.0 52 | license][cc-by-legal]. 53 | 54 | You are free: 55 | 56 | * to **Share**---copy and redistribute the material in any medium or format 57 | * to **Adapt**---remix, transform, and build upon the material 58 | 59 | for any purpose, even commercially. 60 | 61 | The licensor cannot revoke these freedoms as long as you follow the 62 | license terms. 63 | 64 | Under the following terms: 65 | 66 | * **Attribution**---You must give appropriate credit (mentioning that 67 | your work is derived from work that is Copyright © Software 68 | Carpentry and, where practical, linking to 69 | http://software-carpentry.org/), provide a [link to the 70 | license][cc-by-human], and indicate if changes were made. You may do 71 | so in any reasonable manner, but not in any way that suggests the 72 | licensor endorses you or your use. 73 | 74 | **No additional restrictions**---You may not apply legal terms or 75 | technological measures that legally restrict others from doing 76 | anything the license permits. With the understanding that: 77 | 78 | Notices: 79 | 80 | * You do not have to comply with the license for elements of the 81 | material in the public domain or where your use is permitted by an 82 | applicable exception or limitation. 83 | * No warranties are given. The license may not give you all of the 84 | permissions necessary for your intended use. For example, other 85 | rights such as publicity, privacy, or moral rights may limit how you 86 | use the material. 87 | 88 | ### Software 89 | 90 | Except where otherwise noted, the example programs and other software 91 | provided by Software Carpentry and Data Carpentry are made available under the 92 | [OSI][osi]-approved 93 | [MIT license][mit-license]. 94 | 95 | Permission is hereby granted, free of charge, to any person obtaining 96 | a copy of this software and associated documentation files (the 97 | "Software"), to deal in the Software without restriction, including 98 | without limitation the rights to use, copy, modify, merge, publish, 99 | distribute, sublicense, and/or sell copies of the Software, and to 100 | permit persons to whom the Software is furnished to do so, subject to 101 | the following conditions: 102 | 103 | The above copyright notice and this permission notice shall be 104 | included in all copies or substantial portions of the Software. 105 | 106 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 107 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 108 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 109 | NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 110 | LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 111 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 112 | WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 113 | 114 | ### Trademark 115 | 116 | "Software Carpentry" and "Data Carpentry" and their respective logos 117 | are registered trademarks of [NumFOCUS][numfocus]. 118 | 119 | [cc-by-human]: https://creativecommons.org/licenses/by/4.0/ 120 | [cc-by-legal]: https://creativecommons.org/licenses/by/4.0/legalcode 121 | [mit-license]: http://opensource.org/licenses/mit-license.html 122 | [numfocus]: http://numfocus.org/ 123 | [osi]: http://opensource.org 124 | --------------------------------------------------------------------------------