Skip to content

Commit

Permalink
Refer people to The Turing Way
Browse files Browse the repository at this point in the history
  • Loading branch information
bouweandela committed Sep 20, 2023
1 parent bee8b1e commit 31f6942
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 8 deletions.
11 changes: 9 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
# Contributing

This Knowledge Base is primarily written by the eScience Research Engineers at the Netherlands eScience Center. The intended audience is anyone interested in eScience and research software development in general or how this is done at the eScience Center specifically.
This guide is primarily written by the eScience Research Engineers at the Netherlands eScience Center. The intended audience is anyone interested in eScience and research software development in general or how this is done at the eScience Center specifically.

## Scope

To make sure the information in this knowledge base stays relevant and up to date it is intentionally low on technical details. The Knowledge base contains information on the process we use to do projects and develop software.
Please check if your contribution fits in
[The Turing Way](https://github.com/the-turing-way/the-turing-way)
before considering contributing to this guide.
If it does not fit, please open an [issue](https://github.com/NLeSC/guide/issues)
to discuss your planned contribution before starting to work on it, to avoid
disappointment later.

To make sure the information in this guide stays relevant and up to date it is intentionally low on technical details. The guide contains information on the process we use to do projects and develop software.

## Workflow for making contributions

Expand Down
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,15 @@

This is a guide to projects and software development at the Netherlands eScience Center. It both serves as a source of information for exactly how we work at the eScience Center, and as a basis for discussions and reaching consensus on this topic.

**This Guide is a work in progress**

Read this book online here: https://guide.esciencecenter.nl
**Read The Turing Way instead**

If you would like to contribute to this book see [CONTRIBUTING.md](CONTRIBUTING.md).
Most of the generic content of this guide has been moved to
[The Turing Way](https://the-turing-way.netlify.app/index.html).
Because The Turing Way is language agnostic, we have not yet been able to find
an appropriate place for the [language guides](best_practices/language_guides/languages_overview.md),
so we try to keep those up to date.
*Most of the other information is outdated, be careful when using it.*

To see who is responsible for which part of the guide see [chapter_owners.md](chapter_owners.md).
**This Guide is a work in progress**

The guide is best read online, but there is a [PDF document](https://doi.org/10.5281/zenodo.4020564) for offline reading.
If you would like to contribute to this book see [CONTRIBUTING.md](CONTRIBUTING.md).

0 comments on commit 31f6942

Please sign in to comment.