Commit 84db2443 authored by Luke Johnston's avatar Luke Johnston

Merge branch 'contributing-file' into 'master'

Contributing file updates

Closes #20

See merge request !10
parents f6d4cf25 9ea9d748
Pipeline #128471725 failed with stages
in 68 minutes and 31 seconds
image: rocker/tidyverse
stages:
- build
- deploy
......
# Contributor Code of Conduct
This is a compilation of what we consider to be the key points from the
[Mozilla](https://www.mozilla.org/en-US/about/governance/policies/participation/),
[Jupyter](https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md),
and [Ubuntu](https://www.ubuntu.com/community/code-of-conduct) community
guidelines. This isn't an exhaustive list of things that you can't do. Rather,
[Mozilla], [Jupyter], [Contributor Covenant], [Ubuntu] community guidelines.
This isn't an exhaustive list of things that you can or can't do. Rather,
it aims to provide general guidelines for successfully conducting collaborative
work in an exciting and fun environment. Please report unacceptable behavior via
a private message to a project maintainer in [our gitter
channel](https://gitter.im/gwas-rostools/lobby).
a private message to a project maintainer in [our gitter channel](https://gitter.im/gwas-rostools/lobby).
As contributors and maintainers of this project, we pledge to respect all people who
contribute through reporting issues, posting feature requests, updating documentation,
submitting pull requests or patches, and other activities.
[Jupyter]: https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md
[Mozilla]: https://www.mozilla.org/en-US/about/governance/policies/participation/
[Ubuntu]: https://www.ubuntu.com/community/code-of-conduct
[Contributor Covenant]: https://www.contributor-covenant.org
- **Be welcoming, friendly, and patient.**
- We strive to be a community that welcomes and supports people of all
backgrounds and identities. Remember that you can interact with people
from all over the world and that you may be communicating with someone
with a different primary language or cultural background.
- We strive to and are committed to making participation in this project a
harassment-free experience for everyone, regardless of level of experience,
gender, gender identity and expression, sexual orientation, disability, personal
appearance, body size, race, ethnicity, age, or religion.
Remember that you can interact with people from all over the world and
that you may be communicating with someone with a different primary
language or cultural background.
- **Be direct and respectful.**
- We must be able to speak directly when we disagree and when we think we
......@@ -68,5 +78,9 @@ channel](https://gitter.im/gwas-rostools/lobby).
- Repeated harassment of others. In general, if someone asks you to stop,
then stop.
This code of conduct is released under [CC BY-SA
3.0](https://creativecommons.org/licenses/by-sa/3.0/).
Project maintainers have the right and responsibility to remove, edit, or reject comments,
commits, code, wiki edits, issues, and other contributions that are not aligned to this
Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed
from the project team.
This code of conduct is released under [CC BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/).
# Want to contribute?
Great! `r emo::ji("tada")` Thanks for your interest in improving this project!
At this stage, we would very
much appreciate input on [the ideas laid out in the
manifesto](https://manifesto.rostools.org/). Please open a new issue or
reach out to us on Gitter with your feedback (links below).
In general, the best way to get in touch to discuss new ideas is to [open a new
issue](https://gitlab.com/rostools/manifesto/issues/new?issue%5Bassignee_id%5D=&issue%5Bmilestone_id%5D=)
or reach out via the [Gitter chat](https://gitter.im/gwas-rostools/lobby). If
you want to see what we are currently working on, you can look at [the issue
list](https://gitlab.com/rostools/manifesto/issues). Remember to follow the
[Code of Conduct](CODE_OF_CONDUCT.md) when you participate in this project! :smiley:
## Want to be more involved? Here are more ways to help!
This document outlines how to contribute to manifesto repository of the ROStools
project. Here are a few ways that you can contribute:
- Creating a [New Issue] within the [manifesto repository] on ideas or thoughts you may
have about the project
- Check out the [Issues Board] for an overview of what is being worked on and
what you could work on that others aren't
- Participating in discussions on existing [Issues]
- Depending on your interest and level of desired commitment, you can try to
tackle [`Difficulty: Low`]-labeled Issues (or any Issues!)
[`Difficulty: Low`]: https://gitlab.com/rostools/manifesto/issues?label_name%5B%5D=Difficulty%3A+Low
[New Issue]: https://gitlab.com/rostools/manifesto/issues/new?issue%5Bassignee_id%5D=&issue%5Bmilestone_id%5D=
[Issues Board]: https://gitlab.com/rostools/manifesto/-/boards
[Issues]: https://gitlab.com/rostools/manifesto/issues
[manifesto repository]: https://gitlab.com/rostools/manifesto
### Prerequisites
Before you make a substantial pull request, you should always file an issue and
make sure someone from the team agrees that it’s a problem.
### Pull request process
- We recommend that you create a Git branch for each merge request (MR).
- We use [Markdown] to write the documents as [R Markdown] files, then we use
[bookdown] to generate the website (the website is generated automatically
through)
[Markdown]: https://rmarkdown.rstudio.com/authoring_basics.html
[R Markdown]: https://rmarkdown.rstudio.com/lesson-1.html
[bookdown]: https://bookdown.org/yihui/bookdown/
## Submitting
### Code of Conduct
Please note that the manifesto project is released with a [Contributor Code of
Conduct](CODE_OF_CONDUCT.md). By contributing to this project you agree to abide
by its terms.
## Participating in Issue discussions `r emo::ji("thought_balloon")` `r emo::ji("question")`
Helping to contribute can be as simple as giving feedback or suggestions or thoughts about a topic or issue.
You'll need a GitLab account to add your comments to the [Issues] on the [manifesto repository].
As always, make sure to adhere to the [Code of Conduct](CODE_OF_CONDUCT.md).
## Adding to the material `r emo::ji("pencil")` `r emo::ji("computer")`
The material and website are created using [bookdown](https://bookdown.org/yihui/bookdown/),
which renders the R Markdown documents and converts the source material into a static website.
The content is written in [Markdown] format in either a Markdown `.md` file
or in an [R Markdown] `.Rmd` file, so this is the format you would need to use to
add to the content.
Anyone can contribute to the course repository via [merge requests][merge-requests].
Please use [the GitLab flow style][gitlab-flow] to manage changes:
1. Create a [fork][fork-explanation] of the repository, and
[clone][clone-explanation] it to your local computer.
2. In your local copy of this repository, create a new
[branch][branch-explanation].
3. Commit your changes to that branch.
4. Push the edits on that branch to your fork of the course repository.
5. Submit a pull request to the master repository (`rostools/manifesto`).
7. If you receive feedback on your pull request, make further commits to the new
branch on your fork. These will automatically be added to your pull request.
## Acknowledgements
Parts of the file were modified from the [UofTCoders](https://github.com/UofTCoders/studyGroup/blob/gh-pages/CONTRIBUTING.md)
contributing guidelines.
[branch-explanation]: https://docs.gitlab.com/ee/user/project/repository/branches/#branches
[clone-explanation]: https://docs.gitlab.com/ee/gitlab-basics/start-using-git.html#clone-a-repository
[fork-explanation]: https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html
[gitlab-flow]: https://docs.gitlab.com/ee/topics/gitlab_flow.html
[merge-requests]: https://docs.gitlab.com/ee/gitlab-basics/add-merge-request.html
Thanks for your interest in improving this project!
At this stage, we would very much appreciate input on [the ideas laid out in the
manifesto](https://rostools.gitlab.io/manifesto/). Please open a new issue or
# Want to contribute?
Great\! 🎉 Thanks for your interest in improving this project\! At this
stage, we would very much appreciate input on [the ideas laid out in the
manifesto](https://manifesto.rostools.org/). Please open a new issue or
reach out to us on Gitter with your feedback (links below).
In general, the best way to get in touch to discuss new ideas is to [open a new
In general, the best way to get in touch to discuss new ideas is to
[open a new
issue](https://gitlab.com/rostools/manifesto/issues/new?issue%5Bassignee_id%5D=&issue%5Bmilestone_id%5D=)
or reach out via the [Gitter chat](https://gitter.im/gwas-rostools/lobby). If
you want to see what we are currently working on, you can look at [the issue
list](https://gitlab.com/rostools/manifesto/issues). Remember to follow the
[Code of conduct](./CODE_OF_CONDUCT.md) when you participate in this project =)
or reach out via the [Gitter
chat](https://gitter.im/gwas-rostools/lobby). If you want to see what we
are currently working on, you can look at [the issue
list](https://gitlab.com/rostools/manifesto/issues). Remember to follow
the [Code of Conduct](CODE_OF_CONDUCT.md) when you participate in this
project\! :smiley:
## Want to be more involved? Here are more ways to help\!
This document outlines how to contribute to manifesto repository of the
ROStools project. Here are a few ways that you can contribute:
- Creating a [New
Issue](https://gitlab.com/rostools/manifesto/issues/new?issue%5Bassignee_id%5D=&issue%5Bmilestone_id%5D=)
within the [manifesto
repository](https://gitlab.com/rostools/manifesto) on ideas or
thoughts you may have about the project
- Check out the [Issues
Board](https://gitlab.com/rostools/manifesto/-/boards) for an
overview of what is being worked on and what you could work on that
others aren’t
- Participating in discussions on existing
[Issues](https://gitlab.com/rostools/manifesto/issues)
- Depending on your interest and level of desired commitment, you can
try to tackle [`Difficulty:
Low`](https://gitlab.com/rostools/manifesto/issues?label_name%5B%5D=Difficulty%3A+Low)-labeled
Issues (or any Issues\!)
### Prerequisites
Before you make a substantial pull request, you should always file an
issue and make sure someone from the team agrees that it’s a problem.
### Pull request process
- We recommend that you create a Git branch for each merge request
(MR).
- We use
[Markdown](https://rmarkdown.rstudio.com/authoring_basics.html) to
write the documents as [R
Markdown](https://rmarkdown.rstudio.com/lesson-1.html) files, then
we use [bookdown](https://bookdown.org/yihui/bookdown/) to generate
the website (the website is generated automatically through)
## Submitting
### Code of Conduct
Please note that the manifesto project is released with a [Contributor
Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this project
you agree to abide by its terms.
## Participating in Issue discussions 💭 ❓
Helping to contribute can be as simple as giving feedback or suggestions
or thoughts about a topic or issue. You’ll need a GitLab account to add
your comments to the
[Issues](https://gitlab.com/rostools/manifesto/issues) on the [manifesto
repository](https://gitlab.com/rostools/manifesto). As always, make sure
to adhere to the [Code of Conduct](CODE_OF_CONDUCT.md).
## Adding to the material 📝 💻
The material and website are created using
[bookdown](https://bookdown.org/yihui/bookdown/), which renders the R
Markdown documents and converts the source material into a static
website. The content is written in
[Markdown](https://rmarkdown.rstudio.com/authoring_basics.html) format
in either a Markdown `.md` file or in an [R
Markdown](https://rmarkdown.rstudio.com/lesson-1.html) `.Rmd` file, so
this is the format you would need to use to add to the content.
Anyone can contribute to the course repository via [merge
requests](https://docs.gitlab.com/ee/gitlab-basics/add-merge-request.html).
Please use [the GitLab flow
style](https://docs.gitlab.com/ee/topics/gitlab_flow.html) to manage
changes:
1. Create a
[fork](https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html)
of the repository, and
[clone](https://docs.gitlab.com/ee/gitlab-basics/start-using-git.html#clone-a-repository)
it to your local computer.
2. In your local copy of this repository, create a new
[branch](https://docs.gitlab.com/ee/user/project/repository/branches/#branches).
3. Commit your changes to that branch.
4. Push the edits on that branch to your fork of the course repository.
5. Submit a pull request to the master repository
(`rostools/manifesto`).
6. If you receive feedback on your pull request, make further commits
to the new branch on your fork. These will automatically be added to
your pull request.
## Acknowledgements
Parts of the file were modified from the
[UofTCoders](https://github.com/UofTCoders/studyGroup/blob/gh-pages/CONTRIBUTING.md)
contributing guidelines.
......@@ -4,7 +4,10 @@ Title: Heavily Opinionated Manifesto on Reproducible and Open Science Projects.
Version: 0.0.1.9000
Imports:
bookdown,
emo (>= 0.0.0.9000),
tinytex,
kableExtra
Remotes: rstudio/bookdown
Remotes:
rstudio/bookdown,
hadley/emo
License: CCBY-4.0
# manifesto
Contains the opinionated manifesto for conducting a reproducible and open scientific data analysis.
\ No newline at end of file
Contains the opinionated manifesto for conducting a reproducible and open scientific data analysis.
## Contributing
Interested in contributing to the project?
Check out our [contributing guidelines](CONTRIBUTING.md) for more details!
Please note that the 'manifesto' project is released with a
[Contributor Code of Conduct](CODE_OF_CONDUCT.md).
By contributing to this project, you agree to abide by its terms.
......@@ -8,4 +8,6 @@ rmd_files:
- index.Rmd
- introduction.Rmd
- recommendations.Rmd
- CONTRIBUTING.Rmd
- CODE_OF_CONDUCT.md
before_chapter_script: "_common.R"
# bookdown::render_book('index.Rmd', 'bookdown::html_book')
bookdown::render_book('index.Rmd', 'bookdown::gitbook')
bookdown::render_book('index.Rmd', 'bookdown::pdf_book')
rmarkdown::render('CONTRIBUTING.Rmd', 'rmarkdown::github_document')
# bookdown::render_book('index.Rmd', 'bookdown::pdf_book')
......@@ -9,7 +9,7 @@ bookdown::gitbook:
edit:
link: https://gitlab.com/rostools/manifesto/edit/master/%s
text: "Edit"
download: ["pdf"]
#download: ["pdf"]
sharing: no
bookdown::pdf_book:
latex_engine: xelatex
......
# Want to contribute to the ROStools project? Great! :tada:
This document outlines how to contribute to the ROStools
project overall.
TODO: Mimic the tidyverse contribute (https://gitlab.com/rostools/project-management/issues/5)
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment