diff --git a/_quarto.yml b/_quarto.yml index 82ce894..21db591 100644 --- a/_quarto.yml +++ b/_quarto.yml @@ -14,7 +14,6 @@ book: repo-url: https://github.com/getwilds/guide/ chapters: - index.qmd - - help.qmd - contributing.qmd - style.qmd - codereview.qmd diff --git a/contributing.qmd b/contributing.qmd index c24b65b..c0adc12 100644 --- a/contributing.qmd +++ b/contributing.qmd @@ -1,16 +1,19 @@ # Contributing {{< iconify fa6-solid hammer >}} {#sec-contributing} -Contributing guidelines ... write somethig smart here {{< iconify fa6-solid lightbulb >}} +This chapter is intended to direct you to the place you want to be, whether you want to get help, use software, contribute to software, and more. Reminder: the scope of this guide is software maintained by DaSL in the [WILDS GitHub organization][ghwilds]. If you'd like help with your own software schedule a [house call](https://calendly.com/data-house-calls). ## Communication Channels * Slack: Fred Hutch folks can chat with other community members and DaSL and Fred Hutch SciComp staff in the Fred Hutch Data Slack. Join our Slack here {{< iconify fa6-solid hand-point-right >}} +* GitHub Issues: Each GitHub repository has an issues tab where you can ask questions, propose a feature, and more. See below for more details. * Are there others? ## Software This section concerns any software created in the GitHub repositories under the [WILDS GitHub organization](https://github.com/getwilds). +Find the thing you would like to do below and follow its instructions. + **Question**: If you have a question you can ask in the Slack linked above, or open an issue in any of the GitHub repositories. **Bug**: If you want to report a bug, open an issue in the appropriate GitHub repository. @@ -19,4 +22,10 @@ This section concerns any software created in the GitHub repositories under the **Contribute code/docs**: If you want to contribute to software - whether code, documentation or something else - open an issue in the appropriate GitHub repository to discuss, then open a pull request to make your contribution. -**Code of Conduct**: Note that most GitHub repositories should have their own code of conduct. If they do not then ... +**Code of Conduct**: DaSL GitHub repositories should have their own code of conduct - likely some version of the [Contributor Covenant][coc]. Refer to the COC in the repository for specific guidance. + + + +[DaSL]: https://hutchdatascience.org/ +[ghwilds]: https://github.com/getwilds +[coc]: https://www.contributor-covenant.org/version/2/1/code_of_conduct/ diff --git a/help.qmd b/help.qmd deleted file mode 100644 index 0753ece..0000000 --- a/help.qmd +++ /dev/null @@ -1,16 +0,0 @@ -# Help {{< iconify fa6-solid circle-info >}} {#sec-help} - -Getting help .... what to put here ... ? - -## House Calls - -Data House Calls are quick consultations with DaSL staff to get help on data related questions. Fred Hutch staff (and collaborators) can connect with DaSL staff who have expertise on specific topics, or schedule a General Data House Call. - -Schedule a house call here {{< iconify fa6-solid hand-point-right >}} - -## Slack - -Fred Hutch folks can chat with other community members and DaSL and Fred Hutch SciComp staff in the Fred Hutch Data Slack. - -Join our Slack here {{< iconify fa6-solid hand-point-right >}} - diff --git a/index.qmd b/index.qmd index f35af73..d942dd8 100644 --- a/index.qmd +++ b/index.qmd @@ -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/) \ No newline at end of file +- [rOpenSci Dev Guide](https://devguide.ropensci.org/) + + +[DaSL]: https://hutchdatascience.org/ +[R]: https://www.r-project.org/ +[Python]: https://www.python.org/