Contributor's Guide draft #1824
Conversation
|
This is an awesome first pass!! Nothing big jumps out at me as having to be addressed so far. Any additional thoughts @DhairyaLGandhi ? |
|
I get the sense that we need to give more emphasis to writing tutorials and models in addition to the core functionality. We should also talk about the information to be included in an issue and PR and how to present it best. One is to limit PRs to make only the necessary changes, and write motivating tests before hand. |
Co-authored-by: Kyle Daruwalla <daruwalla.k.public@icloud.com>
CONTRIBUTING.md
Outdated
| * [How to file a bug report]() | ||
| * [How to submit a contribution]() | ||
| * [Flux source code organisation]() |
There was a problem hiding this comment.
Should link to the appropriate sections.
There was a problem hiding this comment.
Links fixed. Just a question: does it makes sense to have the section Flux source code organisation? I haven't finished that section and just wondering if it's worth it.
Co-authored-by: Kyle Daruwalla <daruwalla.k.public@icloud.com>
Co-authored-by: Kyle Daruwalla <daruwalla.k.public@icloud.com>
Co-authored-by: Kyle Daruwalla <daruwalla.k.public@icloud.com>
Co-authored-by: Kyle Daruwalla <daruwalla.k.public@icloud.com>
Co-authored-by: Kyle Daruwalla <daruwalla.k.public@icloud.com>
|
@logankilpatrick, @DhairyaLGandhi, @darsnack I've added the suggestions. Could you please have a look at the section Flux source code organization and comment on it. Do you think is worth having it? |
Co-authored-by: Kyle Daruwalla <daruwalla.k.public@icloud.com>
@logankilpatrick, @DhairyaLGandhi can you please have a look at this first draft? Some sections are incomplete and it'd be very helpful if you could give me some feedback on the current content :)