Skip to content
This repository was archived by the owner on Dec 31, 2025. It is now read-only.

Commit b544ff3

Browse files
committed
cleanup
1 parent c9add82 commit b544ff3

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Following these guidelines helps to communicate that you respect the time of the
66

77
This book is an open source project and we love to receive contributions from our community — you! There are many ways to contribute, from contributing new sections or even complete chapters, to submitting reports on typos or writing errors, to everything in between!
88

9-
tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into Elasticsearch itself.
9+
Note: This book may be licensed for publication by a commercial publisher in the future. In such a case the open source version will remain openly available under the same (CC-BY-NC) license. See below for more information on acknowledgment of contributions.
1010

1111
### Ground Rules
1212

@@ -31,6 +31,11 @@ Working on your first Pull Request? You can learn how from this *free* series, [
3131

3232
At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first :smile_cat:
3333

34+
### Recognizing contributors
35+
36+
Individuals who make line-level contributions (such as fixing typos) will be listed in the acknowledgements of the text.
37+
38+
Contributors who create significant new sections or chapters may be listed as coauthors. Individuals who wish to be listed as a coauthor should discuss this with the maintainer prior to contributing, to avoid any misunderstandings.
3439

3540
This Contributors Guide is based on the template from https://github.com/nayafia/contributing-template (CC0).
3641

book/frontmatter.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,13 @@
55

66
Making science more reproducible and transparent is key to improving public trust in science. Because science is increasingly a computational enterprise, improving the quality of scientific research code is essential to making science more reproducible. Increasingly, this code is being written with the help of AI assistants, which can increase productivity but introduces the potential for errors. This book will provide a thorough guide to using AI-assisted coding techniques to generate scientific code that is readable and robust and that can provide reproducible answers to scientific questions.
77

8+
The book is licensed according to the [Creative Commons Attribution-NonCommercial 4.0 Generic (CC BY-NC 4.0) License](https://creativecommons.org/licenses/by-nc/4.0/). Please see the terms of that license for more details.
9+
10+
### Contributing to the book
11+
12+
This book is meant to be a living open-source document, with the source available online at https://github.com/poldrack/BetterCodeBetterScience. If you find any errors in the book or want to make a suggestion for how to improve it, please open an issue on the Github site. Even better, submit a pull request with your suggested changes!
13+
14+
See the [Contributors' Guide](https://github.com/poldrack/BetterCodeBetterScience/blob/main/CONTRIBUTING.md) on Github for more details about contributing to the book.
815

916
```{tableofcontents}
1017
```

0 commit comments

Comments
 (0)