Skip to content

Contributing to nullcal

Thank you for considering contributing to nullcal! We welcome contributions from the community and are excited to work with you. To ensure a smooth contribution process, please follow the guidelines below.

How to Contribute

1. Getting Started

1. Fork the Repository:

  • Click the "Fork" button at the top right of this page to create a copy of this repository under your Git account.

2. Clone Your Fork:

  • Clone the forked repository to your local machine:
git clone https://gitlab.et-gw.eu/eluminat/nullcal.git
  • Navigate to the repository
cd nullcal

3. Create a New Branch:

  • Create a new branch for your changes:
git checkout -b feature/your-feature-name

2. Making Changes

1. Make Your Changes:

  • Implement your changes or new features in your branch.

2. Write Tests:

  • If applicable, write tests to cover your changes. Ensure that all tests pass.

3. Update Documentation:

  • Update the documentation if your changes affect it.

4. Commit Your Changes:

git add .
git commit -m "fix: correct the filter domain in the noise likelihood"

Your pull request title must use one of these prefixes, because CI validates it and the build fails otherwise:

build · chore · ci · docs · feat · fix · perf · refactor · revert · style · test

Note docs, not doc — the shortened form fails the check. A scope is optional: fix(null_stream): .... The changelog is generated from these prefixes, so a mislabelled commit lands in the wrong section or is dropped.

3. Submitting Your Changes

1. Push Your Branch:

  • Push your changes to your forked repository:
git push origin feature/your-feature-name

2. Open a Pull Request:

  • Go to the Pull Requests tab on the main repository.
  • Click "New Pull Request".
  • Select the branch you created and click "Create Pull Request".
  • Provide a descriptive title and detailed description of your changes.

4. Review Process

  • Review: Your pull request will be reviewed by the maintainers. Be prepared to respond to feedback and make additional changes if necessary.
  • Approval: Once approved, your changes will be merged into the release branch.

Code of Conduct

Please adhere to our Code of Conduct to maintain a welcoming and respectful environment for all contributors.

Reporting Issues

If you encounter any issues or bugs, please report them on our Git Issues page. Include relevant details and steps to reproduce the issue.

Contact

For any questions or further assistance, please open an issue on Git.

Thank You!

We appreciate your contributions to nullcal and look forward to your pull requests!