Getting Started: Contributing to PEcAn Project

[dlebauer]

Welcome to the PEcAn Project community! It is always rewarding to see so many people interested in contributing. We’ve had many years of valuable contributions and community building through the Google Summer of Code program.

If you’re interested in contributing to PEcAn, here are some great ways to get started:

0. Read Essential Community Docs

• Code of Conduct
• Contributing

1. Join us on Slack

Register here

2. Issues Labeled "Good First Issue"

We’ve curated a list of tasks that can get you started working on PEcAn without having to dig too deep. You can find them under issues tagged 'good first issue'.

3. Improve Documentation

Documentation is critical to our project. If you encounter anything unclear or have suggestions, feel free to:

• Ask for clarification in the #pecan channel
• Contribute by improving the documentation as you figure things out.

4. Write or Fix Tests

Many tests in our project are commented out and need attention. Focus on modules under modules/<module-name>/tests. Some of these could be revisited and either fixed or deleted. And new tests can be added. Reach out in the #pecan channel if you want help getting started or understanding what is going on.

5. Work on SIPNET

For those with experience or interest in C programming, one of our core models, SIPNET, is written in C. Converting some of the documentation to Doxygen would be a good place to start, and if you get far enough to want to write code, reach out! See the SIPNET Repository.

Feel free to ask questions or let us know which area(s) interest(s) you and what skills you want to develop. Post in the #pecan channel on Slack, and someone from the team will be happy to guide you further.