Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
112 lines (71 loc) · 4.29 KB

CONTRIBUTING.md

File metadata and controls

112 lines (71 loc) · 4.29 KB

🛠️ Contributing Guidelines

🎉 Thank you for your interest in contributing to this project!
Your contributions—big or small—make a meaningful difference. We're grateful to have you here!

We welcome all kinds of contributions. Here are some ways you can get involved:

  • 🐞 Report bugs and request features
    Help us improve by identifying problems or suggesting new ideas.

  • 📝 Write tutorials or examples
    Share how you use the project to help others get started.

  • 📚 Improve documentation
    Clear and accurate docs make the project more accessible to everyone.

  • 💡 Contribute code
    Submit bug fixes, enhancements, or new features that others can benefit from.

If you ever get stuck or have questions, feel free to open an issue or email us directly.

If you're new to open-source, check out GitHub’s guide to contributing and the Zen of Scientific Software Maintenance for best practices on writing high-quality scientific software.

📄 Ground Rules

We strive to create a friendly, respectful, and inclusive community. Please:

  • Be kind and considerate to others
  • Use welcoming and inclusive language
  • Respect differing viewpoints and experiences

All contributors must follow our Code of Conduct. We encourage everyone to read it before participating.

🔗 Useful Links

📑 Contents

🧰 Setting Up Your Development Environment

To get started, follow our setup guide to install ws3 packages and configure your development environment.

🐞 Reporting Bugs

Found a bug? Please open an issue and include the following:

  • A clear description of the issue
  • Steps to reproduce the problem
  • What you expected vs. what actually happened
  • Any error messages or logs
  • Your OS and Python version

💡 Proposing New Features

We’re excited to hear your ideas! Before submitting a feature request:

  1. Search existing issues to avoid duplicates.
  2. If it’s new, open a detailed issue including:
    • A concise summary of the idea
    • Why it's useful or needed
    • Any implementation suggestions or examples

🚀 Pull Request Guidelines

We love pull requests! Please follow these guidelines:

  • Create a branch:
    • For features: feature/your-feature-name
    • For bug fixes: bug/your-bug-name
  • Write clear, well-documented, and testable code
  • Follow PEP 8 style guidelines
  • Add or update tests for your changes
  • Write a clear pull request description
    • Link related issues (e.g., Fixes #42)

All pull requests will be automatically tested via GitHub Actions. Try to make sure all checks pass (green). If you're having trouble, just leave a comment on the PR or reach out—we’re happy to help!

📘 Development Guide

We acknowledge the importance of a structured development guide, especially for growing and collaborative projects. However, given our current limited team size, we have not yet formalized one.

That said, we encourage open collaboration and diverse applications of the project. We aim to grow into a broader development model over time and will revisit this as our community and contributor base expand.

In the meantime, please reach out if you have any specific questions about the internal structure or implementation—we’re always happy to assist!