Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refer people to The Turing Way #285

Merged
merged 2 commits into from
Oct 27, 2023
Merged

Refer people to The Turing Way #285

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
31f6942
Refer people to The Turing Way
bouweandela Sep 20, 2023
aaf0055
Update text as recommended by @egpbos
bouweandela Oct 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
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
21 changes: 14 additions & 7 deletions README.md
View file
Open in desktop
egpbos marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,21 @@

# Guide

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 is a guide to software development at the Netherlands eScience Center.
It both serves as a source of information for 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 The Turing Way instead**

Read this book online here: https://guide.esciencecenter.nl
If you are looking for an overall picture of best practices, read
[The Turing Way](https://the-turing-way.netlify.app/index.html) first.
We joined forces with that guide for most of our generic research software
engineering advice.
Because The Turing Way is language agnostic, this guide mostly provides
addtional specific
[language guides](best_practices/language_guides/languages_overview.md).
*Please be aware that most remaining language agnostic content is outdated,
be careful when using it.*
We plan on removing that content (#286).

If you would like to contribute to this book see [CONTRIBUTING.md](CONTRIBUTING.md).

To see who is responsible for which part of the guide see [chapter_owners.md](chapter_owners.md).

The guide is best read online, but there is a [PDF document](https://doi.org/10.5281/zenodo.4020564) for offline reading.
Loading