Skip to content

Commit 9863c66

Browse files
committed
Provide contribution guidelines
1 parent 24aac3b commit 9863c66

2 files changed

Lines changed: 111 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# Contributing to Compass
2+
3+
Thank you for your interest in contributing to **Compass**!
4+
Compass is an open-source research software project developed in the
5+
context of FAIR Signposting and scholarly communication.
6+
7+
We welcome contributions in many forms — code, documentation, examples,
8+
and discussion.
9+
10+
---
11+
12+
## Ways to contribute
13+
14+
You can contribute by:
15+
16+
- reporting bugs or unexpected behavior,
17+
- improving documentation or examples,
18+
- proposing new features or validation rules,
19+
- submitting code improvements or fixes.
20+
21+
Documentation and examples are first-class contributions.
22+
23+
---
24+
25+
## Reporting issues
26+
27+
Please use **GitHub Issues** to report bugs or propose changes.
28+
29+
When reporting a bug, try to include:
30+
- a minimal, reproducible example,
31+
- the Compass version,
32+
- relevant input data (e.g. WebLinks or Link Sets),
33+
- expected vs. observed behavior.
34+
35+
---
36+
37+
## Proposing changes
38+
39+
For non-trivial changes (new validators, new semantics, API changes),
40+
we strongly recommend opening an issue first to discuss the design.
41+
42+
Compass follows published standards (RFC 8288, RFC 9264, FAIR Signposting).
43+
Proposed changes must align with these specifications.
44+
45+
---
46+
47+
## Code contributions
48+
49+
To contribute code:
50+
51+
1. Fork the repository
52+
2. Create a feature branch
53+
3. Implement your changes
54+
4. Add or update tests
55+
5. Ensure all CI checks pass
56+
6. Open a Pull Request
57+
58+
Please:
59+
- keep changes focused and well-scoped,
60+
- follow the existing coding style,
61+
- include tests for new behavior,
62+
- update documentation where relevant.
63+
64+
---
65+
66+
## Scientific software principles
67+
68+
Compass is developed as **research software**. Contributions should aim to:
69+
70+
- preserve reproducibility and determinism,
71+
- avoid breaking semantics without discussion,
72+
- favor clarity over cleverness,
73+
- document assumptions and decisions.
74+
75+
---
76+
77+
## Review process
78+
79+
All contributions are reviewed by maintainers.
80+
Maintainers may request changes or clarification.
81+
82+
Final decisions on acceptance rest with the project maintainers.
83+
84+
---
85+
86+
## Code of conduct
87+
88+
We expect all contributors to interact respectfully and professionally.
89+
Harassment or exclusionary behavior will not be tolerated.
90+
91+
---
92+
93+
Thank you for helping improve Compass!

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,4 +182,22 @@ Together, they form a clean separation of concerns:
182182
- *Linksmith*: “Is this syntactically valid Web Linking?”
183183
- *Compass*: “Is this WebLink model sound, and what does it mean for FAIR Signposting?”
184184

185+
---
186+
187+
## Contributing
188+
189+
Compass is an open-source research software project and welcomes contributions
190+
from the community.
191+
192+
You can contribute by:
193+
- reporting bugs or unexpected behavior,
194+
- improving documentation or examples,
195+
- proposing new validation rules or features,
196+
- submitting code improvements or fixes.
197+
198+
Please read the
199+
[Contribution Guidelines](CONTRIBUTING.md)
200+
before opening an issue or pull request.
185201

202+
All contributions are reviewed, and design discussions are encouraged —
203+
especially for changes affecting validation semantics or public APIs.

0 commit comments

Comments
 (0)