-
Notifications
You must be signed in to change notification settings - Fork 1
/
CONTRIBUTING.Rmd
42 lines (30 loc) · 2.24 KB
/
CONTRIBUTING.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
---
output:
github_document
---
# Contributing
We appreciate and welcome pull requests from everyone. By participating in this project, you
agree to abide by our [code of conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html).
## Getting Started
* Make sure you have a [GitHub account](https://github.com/signup/free). If you are not familiar with git and GitHub, take a look at <http://happygitwithr.com/> to get started.
* [Submit a post for your issue](https://github.com/ajnafa/Latent-Bayesian-MSM/issues/), assuming one does not already exist.
* Clearly describe your issue, including steps to reproduce when it is a bug, or some justification for a proposed improvement.
* Fork the repository on GitHub to make a copy of the repository on your account. Or use this line in your shell terminal:
`git clone https://github.com/ajnafa/Latent-Bayesian-MSM.git`
## Making changes
* Edit the files, save often, and make commits of logical units, where each commit indicates one concept
* Follow the tidyverse [style guide](https://style.tidyverse.org/index.html).
* Make sure you write [good commit messages](https://cbea.ms/git-commit/).
* Make sure you have added the necessary tests for your code changes.
* Run _all_ the tests using `devtools::check()` to assure nothing else was accidentally broken.
* If you need help or unsure about anything, post an update to [your issue](https://github.com/ajnafa/Latent-Bayesian-MSM/issues/).
## Submitting your changes
Push to your fork and [submit a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
At this point you're waiting on us. We like to at least comment on pull requests
within a few business days. We may suggest some changes or improvements or alternatives.
Some things you can do that will increase the chance that your pull request is accepted:
* Engage in discussion on [your issue](https://github.com/ajnafa/Latent-Bayesian-MSM/issues/).
* Be familiar with the background literature cited in the [README](README.md)
* Write tests that pass.
* Follow our [code style guide](https://style.tidyverse.org/index.html).
* Write a [good commit message](https://cbea.ms/git-commit/).