|
| 1 | +# Contributing to SciLog |
| 2 | + |
| 3 | +Thank you for considering contributing to SciLog! By contributing, you agree to follow our contribution guidelines. |
| 4 | + |
| 5 | +## 1. Code of Conduct |
| 6 | + |
| 7 | +Please adhere to the [Code of Conduct](./CODE_OF_CONDUCT.md) in all interactions with the project. |
| 8 | + |
| 9 | +## 2. How to Contribute |
| 10 | + |
| 11 | +You can contribute by: |
| 12 | + |
| 13 | +- Reporting bugs |
| 14 | +- Suggesting improvements or new features |
| 15 | +- Submitting Pull Requests |
| 16 | + |
| 17 | +## 3. Pull Requests |
| 18 | + |
| 19 | +- All contributions must be made via **pull requests (PRs)**. |
| 20 | +- PRs can come either from a **fork** of the repository or from a **branch** within this repository. |
| 21 | +- PRs are expected to be **atomic**—each PR should contain only one logical change. |
| 22 | +- **Codeowners** will automatically be added as reviewers. |
| 23 | +- You may add any additional reviewers if needed. |
| 24 | +- Make sure to address any comments before merging. |
| 25 | +- **Continuous Integration (CI) must pass** before a PR can be merged. |
| 26 | +- PRs will be **squashed and merged**. |
| 27 | +- The squashed commit should follow **Conventional Commit style**. See here the |
| 28 | + [specification](https://www.conventionalcommits.org/en/v1.0.0/). |
| 29 | +- Include a 'why' in the commit body to document the rationale behind the change. |
| 30 | +This provides essential context for future maintenance and helps others understand the project's growth. |
| 31 | +- By default, the PR title serves as the commit’s subject line, while the PR description populates |
| 32 | +the commit body. |
| 33 | + |
| 34 | +## 4. Additional Guidelines |
| 35 | + |
| 36 | +- Ensure your changes include **documentation updates** when relevant. |
| 37 | +- Follow **existing code style and patterns** in the project. |
| 38 | +- Keep PRs **focused and concise** to make reviewing easier. |
| 39 | + |
| 40 | +## 5. Reporting Issues or Security Concerns |
| 41 | + |
| 42 | +- For **security issues**, please follow the instructions in [SECURITY.md](./SECURITY.md). |
| 43 | +- For other issues or feature requests, use the |
| 44 | + [GitHub Issues page](https://github.com/paulscherrerinstitute/scilog/issues). |
0 commit comments