pvlib / pvlib-python

A set of documented functions for simulating the performance of photovoltaic energy systems.
https://pvlib-python.readthedocs.io
BSD 3-Clause "New" or "Revised" License
1.17k stars 991 forks source link

Split `contributing.rst` #2219

Closed RDaxini closed 6 days ago

RDaxini commented 1 week ago

Save for a few minor edits such as section order, section headings, and section labels, this PR does not make any substantial revisions to the main text of the contributing page. The purpose of this PR is to split the page. There are ongoing discussions about revising the main text and/or creating new sections, which will be handled separately. Somewhat related: #2202 #2205 #2067 #2081

RDaxini commented 1 week ago

@echedey-ls thanks for your suggestions. Just personally, I think it would be more manageable from a discussion, development, and reviewing perspective if we first split what we already have into broadly agreed chunks, and then progressively improve each section through revisions or adding new sections/text. I think rewriting the entire contributing page would be too much in a single PR.

somewhere it was commented (by you IIRC) that a contact note to ask for help would be good, I think we can add that in this PR. Third, citation style recommendation can be put somewhere in this docs (#2202)

Yes correct, so I have begun drafting/building locally but following the suggestion above (and what I believe was also suggested in the associated issues) I think it might be easier if we split the page first, then I will open a PR for these aspects. You can open a separate one too, for example if you have ideas for this:

Basics of how to edit code publicly through GitHub and make pull requests

  • primer on GitHub, GitHub desktop&git, forking, cloning, editing files, pushing changes, creating PRs

I think that alone would be a substantial PR, but still be easier to discuss and review as a single change rather than alongside multiple new pages/text. Linking to this pvlib page might help for that subject btw, personally I found the screenshots and code snippets helpful when setting up not so long ago.

Just my thoughts anyway. I am still learning about the optimal PR scope.

echedey-ls commented 1 week ago

@RDaxini I'm super okay with that, thanks for explaining in depth your PRs procedure. Consider this PR approved from my side. Also, I ran the spell checker and "oveview" is the only warning.

cwhanse commented 6 days ago

I like the split of the material and the new index. As long as that is the scope of this PR, I agree, this is close to ready for merge.

kandersolar commented 6 days ago

This looks good to me, with one exception: it seems like the example gallery section got dropped. Was that intentional?

RDaxini commented 6 days ago

Was that intentional?

Ah no definitely not! My bad. Reinstated in the last commit