Contributing#
We welcome contributions to meaGUI! Whether it’s fixing a bug, improving documentation, or adding features, your help is appreciated.
If you’re new to contributing to open-source projects, here’s a simple path to get started:
Important
This contributing guide is still a work in progress. Full developer setup instructions are coming soon.
Quick Start#
Fork the repository on GitHub.
Clone your fork to your local machine.
Make your changes on a new branch.
Push your branch and submit a pull request (PR).
🎉 That’s it — thank you!
Development Notes#
Make sure your code is clean and readable.
If you’re modifying backend analysis tools, please include example files or test cases if possible.
Style guide: [optional link or note about code style]
If you’re working with HDF5 files and C++ extensions, see our upcoming dev guide for setup instructions.
Note
Still need to document complex developer setup (e.g., HDF5 C++ dependencies). Stay tuned!
Helpful Links#
GitHub repo: your-org/meaGUI
Issues: your-org/meaGUI#issues
Documentation: https://mea-gui.readthedocs.io