-
-
Notifications
You must be signed in to change notification settings - Fork 609
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
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 ? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just some minor changes. This is amazing, thank you!
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 <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for tackling this! This is shaping up really well. I've left a few thoughts on the document so far.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should link to the appropriate sections.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 <[email protected]>
Co-authored-by: Kyle Daruwalla <[email protected]>
Co-authored-by: Kyle Daruwalla <[email protected]>
Co-authored-by: Kyle Daruwalla <[email protected]>
Co-authored-by: Kyle Daruwalla <[email protected]>
@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? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me!
Co-authored-by: Kyle Daruwalla <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you @lilianabs!
@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 :)