1 of 10

1

Tooling for Open Collaboration

​

Setting up a project

Open Seeds by OLS

​

2 of 10

2

3 of 10

Tooling for Open Collaboration

​

​

3

Aim: Help you set up an open and welcoming project repository (online or shared) for your project so that you can work effectively with your team, community and/or contributors

4 of 10

Tooling for Open Collaboration

​

​

4

Learning objectives: At the end of this session, we will be able to

  • Write a README file with information you’d like others to know
  • Explain why you need an open source license and choose one
  • Add a Code of Conduct about you can make working online for your contributors welcoming and safe

5 of 10

Project Structure and Organization

​

​

5

├── docs

​

├── images

​

├── src

​

├── CODE_OF_CONDUCT.md

​

├── CONTRIBUTING.md

​

├── LICENSE.md

​

├── README.md

​

├── ROADMAP

​

├── …

​

6 of 10

Project Structure and Organization

​

​

6

├── docs

​

├── images

​

├── src

​

├── CODE_OF_CONDUCT.md

​

├── CONTRIBUTING.md

​

├── LICENSE.md

​

├── README.md

​

├── ROADMAP

Presented in Week 02

├── …

​

7 of 10

Project Structure and Organization

​

​

7

├── docs

​

├── images

​

├── src

​

├── CODE_OF_CONDUCT.md

​

├── CONTRIBUTING.md

​

├── LICENSE.md

​

├── README.md

​

├── ROADMAP

Presented at the last call

├── …

​

  • Essential information for your collaborative project (open canvas)
  • A roadmap with short-term and long-term goals making it easy for others to know where they can contribute

8 of 10

Project Structure and Organization

​

​

8

├── docs

​

├── images

​

├── src

​

├── CODE_OF_CONDUCT.md

​

├── CONTRIBUTING.md

​

├── LICENSE.md

​

├── README.md

Presented today*

├── ROADMAP

​

├── …

​

* Talks in previous cohorts, available on the Open Seeds Video Library

9 of 10

Project Structure and Organization

​

​

9

├── docs

​

├── images

​

├── src

​

├── CODE_OF_CONDUCT.md

Presented today*

├── CONTRIBUTING.md

​

├── LICENSE.md

​

├── README.md

Presented today*

├── ROADMAP

​

├── …

​

* Talks in previous cohorts, available on the Open Seeds Video Library

10 of 10

Project Structure and Organization

​

​

10

├── docs

​

├── images

​

├── src

​

├── CODE_OF_CONDUCT.md

Presented today*

├── CONTRIBUTING.md

​

├── LICENSE.md

Presented today*

├── README.md

Presented today*

├── ROADMAP

​

├── …

​

* Talks in previous cohorts, available on the Open Seeds Video Library