This repository has been archived by the owner on Jan 24, 2024. It is now read-only.
[Challenging] Contribute to pvlib #5
kandersolar
started this conversation in
Project Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
This project is for you who's been wanting to contribute to pvlib-python but haven't found the time. Yet! Here's a chance to leave your mark on pvlib!
Prerequisites: You have some experience with Python, feel comfortable writing your own functions, and are generally familiar with git. The pvlib maintainers will be available to help you during the session.
The task is to close an open issue. Look at pvlib on github and find an issue with a label "good first issue" or "help wanted". Some suggestions: #1892, #1697, or for bonus credit, work towards closing the second-oldest open issue #62,
Step 1 - Fork the pvlib python package either using git or GitHub Desktop
Step 2 - Create a branch for the changes you will make.
Step 3 - Edit the pvlib source files and commit the edited files to your branch.
Step 4 - Read the pvlib contributing guidelines
Step 5 - Create a pull request to pvlib.
Step 6 - Request a review from the pvlib maintainers on GitHub (ask one of us to do it in real-time during the pvlib session). Address any concerns that arise.
Step 7 - Add information about the changes to the current "what's new" file.
Step 7- Examine the CI results and correct formatting, fix unit tests, and check code coverage. Review the documentation pages that have changed. If you are a first-time contributor, a maintainer will launch the continuous integration (CI) jobs for your pull request; otherwise they should launch automatically when you submit the pull request.
Thanks for the initial work on your contribution. More reviews are likely to follow from other maintainers and it may be a week or more before the pull request is ready to merge. Please be patient as we follow good open-source code practices.
Beta Was this translation helpful? Give feedback.
All reactions