Skip to content

Commit 5cd5e9e

Browse files
committed
Init commit
1 parent 735a16a commit 5cd5e9e

1 file changed

Lines changed: 119 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
# Contributing to `iddoverse`
2+
3+
Thank you for your interest in contributing to `iddoverse`.
4+
5+
`iddoverse` supports infectious disease researchers by making it easier to work with data from the IDDO data repository. We welcome contributions that improve the package, fix problems, strengthen documentation, or help researchers use the tools more effectively.
6+
7+
We aim to keep the project open, clear, and useful for the global research community. Whether you are fixing a typo, suggesting a new feature, or contributing code, we appreciate your help.
8+
9+
------------------------------------------------------------------------
10+
11+
# Before you start
12+
13+
Please:
14+
15+
- read the existing documentation and open issues before you begin
16+
- check whether someone is already working on the same problem
17+
- open an issue before starting major changes
18+
- keep pull requests focused on one change where possible
19+
20+
If you are unsure where to start, get in touch through GitHub Issues.
21+
22+
------------------------------------------------------------------------
23+
24+
# Ways to contribute
25+
26+
You can contribute in several ways.
27+
28+
## Report bugs
29+
30+
Please open a GitHub Issue if you find:
31+
32+
- errors or unexpected behaviour
33+
- problems with documentation
34+
- installation issues
35+
- broken examples or workflows
36+
37+
When reporting a bug, include:
38+
39+
- what you expected to happen
40+
- what happened instead
41+
- a reproducible example
42+
- your operating system
43+
- your R version
44+
- package versions where relevant
45+
46+
Clear examples help us fix problems quickly.
47+
48+
## Suggest improvements
49+
50+
We welcome ideas that help researchers use `iddoverse` more effectively.
51+
52+
Examples include:
53+
54+
- new features
55+
- better workflows
56+
- improved documentation
57+
- performance improvements
58+
- accessibility improvements
59+
60+
Please explain:
61+
62+
- the problem you want to solve
63+
- why the change would help users
64+
- any suggested implementation details
65+
66+
## Contribute code
67+
68+
We welcome pull requests for:
69+
70+
- bug fixes
71+
- new features
72+
- tests
73+
- documentation updates
74+
- performance improvements
75+
76+
Please keep changes as small and focused as possible.
77+
78+
### Pull requests
79+
80+
#### Before submitting
81+
82+
Please make sure that you have:
83+
84+
- added or updated tests
85+
- updated documentation where needed
86+
- run package checks
87+
- checked that examples work
88+
89+
#### When you open a pull request:
90+
91+
- Describe the change clearly
92+
- Link related issues where relevant
93+
- Explain any important design decisions
94+
95+
A member of our team will review your contribution and may suggest changes before merging.
96+
97+
We aim to review pull requests as quickly as possible, but response times may vary depending on team capacity.
98+
99+
------------------------------------------------------------------------
100+
101+
# Licensing
102+
103+
By contributing to `iddoverse`, you agree that your contributions will be released under the [project licence](https://github.com/Infectious-Diseases-Data-Observatory/iddoverse/blob/main/LICENSE.md).
104+
105+
------------------------------------------------------------------------
106+
107+
# Code of conduct
108+
109+
We expect contributors to:
110+
111+
- treat others with respect
112+
- give constructive feedback
113+
- support an inclusive research community
114+
115+
We do not tolerate harassment, discrimination, or abusive behaviour.
116+
117+
------------------------------------------------------------------------
118+
119+
We welcome contributions from researchers, developers, analysts, and the wider global health community.

0 commit comments

Comments
 (0)