# Contributing to aiida-amber

Thank you for your interest in contributing to **aiida-amber**!

We’re excited to collaborate with developers, researchers, and community members to make aiida-amber better for everyone.

This guide explains how to set up your environment, make changes, and submit them for review. Whether you’re fixing a bug, improving documentation, or adding new features, every contribution makes a difference.

---

## Getting Started

Before contributing, please review the [Developer Guide](https://aiida-amber.readthedocs.io/en/latest/developer_guide/index.html).
It covers aiida-amber’s architecture, setup instructions, and contribution workflow.

If you’re new to the project, we also recommend:
- Reading the [README](../README.md) for an overview and installation details.
- Checking open [issues]() labeled **good first issue** to find beginner-friendly tasks.

---

## Submitting a Pull Request (PR)

When you’re ready to submit your work:

1. **Push your branch** to GitHub.
2. **Open a [pull request](https://help.github.com/articles/using-pull-requests/)** against the `main` branch.
3. **Fill out the PR template**, including:
   - A concise summary of what your PR does
   - A list of all changes introduced
   - Details on how these changes affect the repository (features, tests, documentation, etc.)
4. **Verify before submission**:
   - All tests pass
   - Pre-commit checks succeed
   - Documentation is updated where applicable
5. **Review process**:
   - Your PR will be reviewed by the core development team.
   - At least **one approval** is required before merging.

We aim to provide constructive feedback quickly and appreciate your patience during the review process.

---

## Reporting Issues

Found a bug or have a feature request?

1. **Open a new issue** on GitHub.
2. Provide a **clear and descriptive title**.
3. Include:
   - Steps to reproduce the issue (if applicable)
   - Expected vs. actual behavior
   - Relevant logs, screenshots, or input files

Well-documented issues help us address problems faster and keep aiida-amber stable and robust.

---

## Additional Resources

- [GitHub Docs](https://help.github.com/)

---

Thank you for helping improve **aiida-amber**, your contributions make open source stronger!
