Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
79 lines (51 loc) · 2.34 KB

CONTRIBUTING.md

File metadata and controls

79 lines (51 loc) · 2.34 KB

Contributing to Nuclear Physics Library

Thanks for your interest in contributing to this project! We welcome contributions of all types, including bug fixes, new features, improved tests, documentation enhancements, and suggestions.

How to Contribute

Contributions follow the standard GitHub workflow:

  1. Fork the repository
    Click the “Fork” button in the top‑right of the repo page.

  2. Clone your fork locally

   git clone https://github.com/PolskaKrowa/nuclear‑physics‑library.git
   cd nuclear‑physics‑library
  1. Create a feature branch
git checkout -b feature/your‑feature‑name

  1. Make your changes Follow the code style conventions and add tests where appropriate.

  2. Commit your work Write clear commit messages and describe the changes.

  3. Push to your fork

git push origin feature/your‑feature‑name
  1. Open a Pull Request Go to the original repository and click “New Pull Request”. Describe what you’ve done and why.

Before Opening a Pull Request

To make reviewing easier:

  • Ensure tests pass Run the test suite locally and confirm everything passes.

  • Keep commits small and logical Group related changes together.

  • Document your changes Update docs or examples if your changes add or alter functionality.

Reporting Issues

If you find a bug or want to request a new feature:

  1. Go to the Issues tab in this repository.
  2. Search to see if the issue already exists.
  3. If not, click New issue and provide a clear description of the problem or suggestion.

Code Style and Expectations

To maintain quality:

  • Follow the indentation and formatting conventions you see in the existing codebase (e.g., consistent indentation, naming schemes).
  • Add comments for complex logic.
  • Write unit tests for new features where feasible.
  • Objective and clear commit messages help reviewers.
  • SI units where applicable (non-SI units are strongly discouraged unless absolutely necessary.)

Communication

For questions or broader discussions:

  • Use the repository’s Discussions page.
  • Tag maintainers or relevant contributors in your comments.

Thank You!

Every contribution helps grow this project and supports others using it. Even small improvements like fixing typos or improving documentation are appreciated.