We welcome contributions from anyone interested in improving the GFM! To contribute to the model use the following steps:
- Fork and clone the repository and change into the directory
git clone https://github.com/your-username/geophysical-foundation-model.git
cd geophysical-foundation-model- Create a new branch for your changes:
git checkout -b feature/super-sweet-feature- Make your changes and commit them:
git add .
git commit -m "Add a super sweet new feature"- Push your changes to your forked repository:
git push origin feature/super-sweet-feature- Create a pull request from your forked repository back to the original repository.
- Once your changes are pushed, navigate to the original repository on GitHub and click on the "Pull Requests" tab.
- Click on the "New Pull Request" button and compare against the main branch.
- Fill out the pull request template with all relevant details including a clear description of the problem or feature being addressed
Follow Coding Conventions:
- Follow Python's official style guide (PEP 8).
- Use meaningful variable names.
- Write clear and concise code.
- We strongly recommend using black for formatting
Address Feedback:
- If a maintainer provides feedback on your pull request, address the comments and make necessary revisions.
- Commit additional changes to your feature branch and push them again.
Documentation Contributions:
- If your contribution involves updates to documentation, please follow the guidelines in
CONTRIBUTING_DOCS.md. - Ensure that all new or modified documentation is accurate and easy to understand.
Reporting Bugs:
- If you find a bug, search on GitHub under Issues to ensure it hasn't already been reported.
- Create a new issue and use the relevant bug report template.
Engage with the Community:
- Join our community discussions.
- Engaging with other contributors can help accelerate the development of new features and improvements.
Thank you for contributing to the Geophysical Foundation Model and we hope to see you on a leaderboard soon!