Contributing to Borealis

Thank you for your interest in contributing to Borealis!

We welcome contributions of all kinds — from bug reports and feature requests to documentation improvements and code enhancements.

🧭 Getting Started

1. Fork the repository
2. Clone your fork:

   git clone https://github.com/your-username/Borealis.git
   cd Borealis
   

3. Create a branch for your changes:

   git checkout -b feature/your-feature-name
   

🛠️ Development Setup

To set up your development environment:

conda env create -f env.yml
conda activate borealis

Make sure your changes follow the project’s structure and style.

🧪 Testing Your Changes

Please test your changes before submitting a pull request. If applicable, include:

• Unit tests
• Example scripts
• Updated documentation

🚀 Submitting a Pull Request

1. Push your branch:

   git push origin feature/your-feature-name
   

2. Open a pull request on GitHub
3. Provide a clear description of your changes and link to any related issues

🤝 Code of Conduct

Please be respectful and inclusive. We follow a Code of Conduct to ensure a welcoming environment for everyone.

🙋‍♀️ Need Help?

If you’re unsure where to start or have questions, feel free to open an issue or reach out!