Conde of Conduct for interacting wihtin the BioPAL community
We want your help! BioPAL is an open source project that is supported by a community who welcomes your enthusiasm and expertise! We will gratefully accept any contribution you might make to the project. Large or small, any contribution makes a big difference; and if you have never contributed to an open source project before, we hope you will start with BioPAL!
It is important to us to create a open and inclusive community that values it’s diversity. In oder to achieve this, we all abide by our Code of Conduct. Please make sure to get to know this Code of Conduct when interacting within the community.
The main goal of BioPAL is to advance the BIOMASS core processing algorithms for Forest Height estimation, Forest Disturbance assessment, or Above Ground Biomass estimation. We are always on the lookout for advances in estimating these metrics. If you have a novel integration of such an algorithm feel free to create an issue, a pull request or reach out to us via the slack channel.
However, open-source is about much more than contributing with new algorithms, we need your help in many ways:
- Submit a bug report or feature request on GitHub issues.
- Contribute an Jupyter notebook to our examples gallery.
- Assist us with user testing.
- Add to the documentation or help with our website, biopal.org
- Write unit or integration tests for our project.
- Answer questions on our GitHub issues, the MAAP forums, Slack channels, Stack Overflow, and Twitter.
- Translate our documentation into another language.
- Write a blog post, tweet, or share our project with others.
- Teach someone how to use BioPAL
Starting to Contribute
Whether you are a first time contributor to open-source or a seasoned open-source veteran interested in joining the BioPAL community, this section will guide you in:
- getting familiar with teh BioPAL Code of Conduct
- setting up and working with git
- setting up a BioPAL working environment
- and getting to know the standards to use when submitting a contribution to BioPAL
Getting started with git