You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 14, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,13 +26,13 @@ If you're wishing for a feature that doesn't exist yet in MXFusion, there are pr
26
26
27
27
If you're thinking about adding code to MXFusion, here are some guidelines to get you started.
28
28
29
-
* If the change is a major feature, create a [design proposal](design_proposal/design_proposal_guidelines) in the design_proposals folder and post it as a PR, optionally with a prototype implementation of your proposed changes. This is to get community feedback on the changes and document the design reasoning of MXFusion for future reference.
29
+
* If the change is a major feature, create a [design proposal](docs/design_proposals/design_proposal_guidelines.md) in the design_proposals folder and post it as a PR, optionally with a prototype implementation of your proposed changes. This is to get community feedback on the changes and document the design reasoning of MXFusion for future reference.
30
30
31
31
* Keep pull requests small, preferably one feature per pull request. This lowers the bar to entry for a reviewer, and keeps feedback focused for each feature.
32
32
33
33
Some major areas where we appreciate contributions:
34
34
*[Adding new Distributions/Functions/Modules](examples/notebooks/writing_a_new_distribution.ipynb)
35
-
*[Adding new Inference Algorithms](design_documents/inference)
35
+
*[Adding new Inference Algorithms](docs/design_documents/inference.md)
36
36
* Example notebooks showing how to build/train a particular model.
37
37
38
38
If you're still not sure where to begin, have a look at our [issues](issues TODO) page for open work.
@@ -73,7 +73,7 @@ Before submitting the pull request, please go through this checklist to make the
73
73
* Do all public functions have docstrings including examples? If you added a new module, did you add it to the Sphinx docstring in the ```__init__.py``` file of the module's folder?
74
74
* Is the code style correct (PEP8)?
75
75
* Is the commit message formatted correctly?
76
-
* If this is a large addition, is there a tutorial or more extensive module-level description? Did you discuss the addition in a [design proposal](design_proposals/design_proposal_guidelines)? Is there an issue related to the change? If so, please link the issue or design doc.
76
+
* If this is a large addition, is there a tutorial or more extensive module-level description? Did you discuss the addition in a [design proposal](docs/design_proposals/design_proposal_guidelines.md)? Is there an issue related to the change? If so, please link the issue or design doc.
0 commit comments