Skip to content

Commit

Permalink
edited contrib guidlines
Browse files Browse the repository at this point in the history
  • Loading branch information
till-tietz committed Oct 29, 2024
1 parent 3193825 commit bcf1f66
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
## Contributing to CausalQueries

:tada: Welcome to our contribution guidelines and thank you for your interesting in contributing!
:tada: Welcome to our contribution guidelines and thank you for your interest in contributing!


### Reporting a bug
Before you report a bug make sure the same bug hasn't been reported before. We track bugs as [issues on GitHub](https://github.com/macartan/CausalQueries/issues).
If no related issue has been opened, create an issue keeping in mind the following guidelines:

- Use an informative title
- Write a minimal working example that allow us to reproduce the bug you found
- Write a minimal working example that allows us to reproduce the bug you found
- If the bug you're reporting crashes your R session, please mention that in the title

### Contributing code
Expand All @@ -17,14 +17,14 @@

- Fork the [CausalQueries repository](https://github.com/macartan/CausalQueries)
- Clone your fork locally
- Be always up to date with the `master`
- Always be up to date with the `master` branch
- Add your edits
- Run and pass `devtools::check()`
- Reach a 100% coverage `covr::package_coverage()`
- Add yourself as a contributor in the `DESCRIPTION` file
- Open a pull request


Note: members of the `CausalQueries` community can skip the first two bullet points above and branch out instead.
Note: members of the `CausalQueries` dev team can skip the first two bullet points above and branch out instead.


0 comments on commit bcf1f66

Please sign in to comment.