Improve contributing.md #1488
Improve contributing.md #1488
Conversation
Codecov Report
@@ Coverage Diff @@
## develop #1488 +/- ##
========================================
Coverage 95.27% 95.27%
========================================
Files 82 82
Lines 3743 3743
========================================
Hits 3566 3566
Misses 177 177 Continue to review full report at Codecov.
|
|
|
||
| ### I have this big feature/extension I would like to add... | ||
|
|
||
| Due to limited scope we may not be able to review and merge every feature, however useful it may be. Particularly large contributions or changes to core code are harder to justify against the scope of the project or future development plans. For such contributions, we suggest you publish them as a separate package that extends GPflow. We can link to your project from an issue discussing the topic or within the repository. Discussing a possible contribution in an issue should give an indication to how broadly it is supported to bring it into the codebase. | ||
|
|
||
| ### ...but it won't work without changes to GPflow core? | ||
|
|
||
| We aim to have the GPflow core infrastructure be sufficiently extensible and modular to enable a wide range of third-party extensions without having to touch the core of GPflow. The `inducing_variables` module is an example of this to enable interdomain approximations (multiscale inducing features, Fourier features, etc.). If your feature/extension does not work outside of GPflow-core because something is hard-coded, please open an issue to discuss this with us! | ||
| We aim to have the GPflow core infrastructure be sufficiently extensible and modular to enable a wide range of third-party extensions without having to touch the core of GPflow. The `inducing_variables` module is an example of this to enable interdomain approximations (multiscale inducing features, Fourier features, etc.). If your feature/extension does not work outside of GPflow-core because something is hard-coded, please open an issue to discuss this with us! We are happy to discuss and implement changes to the core code that make it easier for you to extend GPflow with a separate package. |
There was a problem hiding this comment.
We are happy to discuss and implement changes to the core code that make it easier for you to extend GPflow with a separate package.
are we definitely happy to implement the changes?
There was a problem hiding this comment.
if we discuss and agree we should do it, yes - I don't want it to seem like it'd be up to the external person to fix gpflow-core to make it more modular&extendible.
There was a problem hiding this comment.
if we discuss and agree we should do it
exactly. but this isn't mentioned in the text (the fact that we'd need to agree to it)
There was a problem hiding this comment.
Then, please, leave a suggestion as to how you'd word it. I don't see the issue you seem to have with this change.
There was a problem hiding this comment.
suggestion: remove "and implement"
Co-authored-by: joelberkeley-pio <joel.berkeley@prowler.io>
Resolves #1474 and some other minor improvements to contributing.md.