ContributeΒΆ

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. You can contribute in the ways listed below.

Repository structureΒΆ

The public GitHub repository has the following structure:

| The Environmental Data Science Book
| β”œβ”€β”€ **/.github**
| β”‚   β”œβ”€β”€ ISSUE_template
| β”‚   β”œβ”€β”€ workflows
| β”‚   └── ...
| β”œβ”€β”€ **/book**
| β”‚   β”œβ”€β”€ _toc.yml
| β”‚   β”œβ”€β”€ _config.yml
| β”‚   └── ...
| β”œβ”€β”€ CODE_OF_CONDUCT.md
| β”œβ”€β”€ CONTRIBUTING.md
| └── ...

The .github folder refers to GitHub related deployment files and templates of issues/pull requests usually curated by the repository maintainers or developers. The book folder holds the website content and other relevant files (table of content and configuration files).

For the book content, the following contributions are accepted:

  • Narrative content: include plain text, citations, equations, figures, special content blocks and more.

  • Executable content: consists of computational material in a given programming language e.g. python.

See also

Please visit the corresponding Jupyter Book guidelines for narrative and executable content.

The _toc.yml file sets the main sections of EDS book. It is a simple configuration file specifying a table of content from all the executable and narrative content found in the book folder (and in subfolders). The current version of the book consists of five key sections:

  • Preamble: contains narrative content i.e. plain markdown files describing the aims of the book, the target audience, how to use, attribution and how to contribute.

  • Gallery: contains all published executable content. Notebooks are categorised across different themes: exploration, modelling, etc to differentiate the type of analysis or procedure.

  • Publishing: provides an introduction of peer-reviewing notebooks, its relevance and guidelines to publish in EDS book.

  • Community: compiles community-related resources such as notes of co-working meetings.

  • Afterword: describes miscellaneous material such as glossary and bibliography.

RolesΒΆ

Inspired by the Turing Way Guide for Collaboration, EDS book has the following defined community roles:

  • Maintainers: to provide support with keeping the existing source code updated by keeping track of new contributions and/or update versions of the Jupyter book.

  • Contributors: to create/design narrative and/or executable content.

  • Reviewers: to review narrative and/or executable content.

  • Readers/Users: to read/share content, occasionally raise errors such as typos and bugs and fix them.

Recognising ContributionsΒΆ

We welcome and recognise all kinds of contributions, from fixing small errors, to developing documentation, maintaining the project infrastructure, writing or reviewing narrative and/or executable notebooks.

EDS book follows the all-contributors specifications. The all-contributors bot usage is described here. You can see a list of current contributors here.

Code of ConductΒΆ

Please note that EDS book open-source repository and community are aligned with a Contributor Code of Conduct. By contributing to EDS book you agree to abide by its terms.