Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
154 lines (92 loc) · 3.24 KB

CONTRIBUTING.md

File metadata and controls

154 lines (92 loc) · 3.24 KB

Contributing to MaStr_Visualizer

Thank you for your interest in contributing to MaStr_Visualizer! 🎉 We welcome contributions of all kinds—bug reports, feature requests, documentation improvements, and code contributions.

Please take a moment to review this guide before contributing.

📜 License and Legal Notice

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).

By contributing to this repository, you agree that:

  • Your contributions will be licensed under AGPL-3.0
  • You have the right to submit the code (i.e., it is your own work or compatible with AGPL-3.0)

Do not submit code copied from sources that are incompatible with AGPL-3.0.

🐞 Reporting Bugs

If you find a bug, please open an issue and include:

  • A clear and descriptive title
  • Steps to reproduce the issue
  • Expected behavior vs. actual behavior
  • Screenshots or logs (if applicable)
  • Your environment (OS, browser, Python version, etc.)

👉 Use GitHub Issues for all bug reports.

💡 Feature Requests

We welcome feature suggestions!

When opening a feature request, please include:

  • The problem you’re trying to solve
  • Why the feature would be useful
  • Any alternative solutions you’ve considered

🔧 How to Contribute Code

1. Fork the Repository

Click the Fork button on GitHub and clone your fork locally:

git clone https://github.com/<your-username>/MaStr_Visualizer.git
cd MaStr_Visualizer

2. Create a Branch

Create a new branch for your contribution:

git checkout -b feature/your-feature-name

or

git checkout -b bugfix/issue-number

3. Make Your Changes

  • Follow the existing project structure and coding style
  • Write clear, readable, and well-documented code
  • Keep commits focused and meaningful

4. Test Your Changes

Before submitting:

  • Ensure the project runs correctly
  • Add or update tests if applicable
  • Make sure nothing else is broken

5. Commit Your Changes

Write clear commit messages:

git commit -m "Add visualization for XYZ metric"

6. Submit a Pull Request (PR)

  • Push your branch to your fork
  • Open a Pull Request against the main branch
  • Reference any related issues (e.g., Fixes #12)
  • Clearly describe what your PR does

A maintainer will review your PR and may request changes.

🧹 Code Style Guidelines

  • Use consistent formatting
  • Keep functions small and focused
  • Add comments where logic is non-obvious
  • Follow language-specific best practices (Python/JS/etc.)

If a formatter or linter is added later, please use it.

🌐 AGPL-Specific Note (Important)

If you modify this software and deploy it as a network service (e.g., web app, dashboard, hosted tool), the AGPL requires you to make the source code available to users of that service.

By contributing, you acknowledge and accept this requirement.

🤝 Code of Conduct

Be respectful and constructive in discussions. Harassment, discrimination, or abusive behavior will not be tolerated.

📬 Questions?

If you have questions:

  • Open a GitHub Issue
  • Or start a discussion (if enabled)

Thank you for contributing to MaStr_Visualizer 🚀

Crafted with llm