-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
- Loading branch information
Showing
4 changed files
with
28 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,30 @@ | ||
# Welcome {.unnumbered} | ||
|
||
This book is a resource for anyone in the [Fred Hutch Cancer Center Data Science Lab](https://hutchdatascience.org/) community contributing to or using software. | ||
::: {.callout-warning} | ||
This guide is under construction - content changes often. | ||
::: | ||
|
||
The book attempts to cover all important aspects of software development, including how to get involved in software as a user or contributor, code style, code review, package documentation, and more. It includes both internal facing guidelines as well as for any contributions from folks other than DaSL staff. | ||
This book is a resource for the community of people using, contributing to, and maintaining software at the Fred Hutch Cancer Center Data Science Lab ([DaSL][]). | ||
|
||
- Getting help: @sec-help | ||
- Contributing guidelines: @sec-contributing | ||
- Style guidelines: @sec-style | ||
- Code review guidelines: @sec-review | ||
- Package documentation guidelines: @sec-docs | ||
The book covers important aspects of software development, including how to get involved in software as a user or contributor, code style, code review, package documentation, and more. It includes both internal facing guidelines as well as for any contributions from folks other than DaSL staff. | ||
|
||
- Contributing: @sec-contributing | ||
- Style: @sec-style | ||
- Code review: @sec-review | ||
- Package documentation: @sec-docs | ||
- Package maintenance: @sec-maintenance | ||
- Security: @sec-security | ||
|
||
|
||
[DaSL][] primarily develops software in the [R][] and [Python][] programming languages. Where necessary, we'll discuss a topic with respect to both languages. | ||
|
||
## Inspiration | ||
|
||
Inspiration for this guide is taken in part from: | ||
|
||
- [Tidyverse Style Guide](https://style.tidyverse.org/) | ||
- [rOpenSci Dev Guide](https://devguide.ropensci.org/) | ||
- [rOpenSci Dev Guide](https://devguide.ropensci.org/) | ||
|
||
|
||
[DaSL]: https://hutchdatascience.org/ | ||
[R]: https://www.r-project.org/ | ||
[Python]: https://www.python.org/ |