Skip to content

Commit b9eda8e

Browse files
authored
Replace CONTRIBUTING.rst with CONTRIBUTING.md (mlflow#6791)
Signed-off-by: harupy <[email protected]> Signed-off-by: harupy <[email protected]>
1 parent f3effbc commit b9eda8e

File tree

12 files changed

+15
-15
lines changed

12 files changed

+15
-15
lines changed

.github/ISSUE_TEMPLATE/feature_request_template.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ body:
77
- type: markdown
88
attributes:
99
value: |
10-
Thank you for submitting a feature request. **Before proceeding, please review MLflow's [Issue Policy for feature requests](https://www.github.com/mlflow/mlflow/blob/master/ISSUE_POLICY.md#feature-requests) and the [MLflow Contributing Guide](https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.rst)**.
10+
Thank you for submitting a feature request. **Before proceeding, please review MLflow's [Issue Policy for feature requests](https://www.github.com/mlflow/mlflow/blob/master/ISSUE_POLICY.md#feature-requests) and the [MLflow Contributing Guide](https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.md)**.
1111
**Please fill in this feature request template to ensure a timely and thorough response.**
1212
- type: dropdown
1313
id: contribution
@@ -49,7 +49,7 @@ body:
4949
attributes:
5050
label: Details
5151
description: |
52-
Use this section to include any additional information about the feature. If you have a proposal for how to implement this feature, please include it here. For implementation guidelines, please refer to the [Contributing Guide](https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.rst#contribution-guidelines).
52+
Use this section to include any additional information about the feature. If you have a proposal for how to implement this feature, please include it here. For implementation guidelines, please refer to the [Contributing Guide](https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.md#contribution-guidelines).
5353
validations:
5454
required: false
5555
- type: checkboxes

.github/workflows/notify-dco-failure.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ module.exports = async ({ context, github }) => {
3636
const body = [
3737
`@${user.login} Thanks for the contribution! The DCO check failed. `,
3838
`Please sign off your commits by following the instructions here: ${dcoCheck.html_url}. `,
39-
"See https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.rst#sign-your-work for more ",
39+
"See https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.md#sign-your-work for more ",
4040
"details.",
4141
].join("");
4242
await github.issues.createComment({

CODE_OF_CONDUCT.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Enforcement
6262
###########
6363

6464
Instances of abusive, harassing, or otherwise unacceptable behavior may be
65-
reported by contacting the Technical Steering Committee defined `here <https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.rst#governance>`_.
65+
reported by contacting the Technical Steering Committee defined `here <https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.md#governance>`_.
6666
All complaints will be reviewed and investigated and will result in a response that
6767
is deemed necessary and appropriate to the circumstances. The project team is
6868
obligated to maintain confidentiality with regard to the reporter of an incident.

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -65,13 +65,13 @@ MLflow committers actively [triage](ISSUE_TRIAGE.rst) and respond to
6565
GitHub issues. In general, we recommend waiting for feedback from an
6666
MLflow committer or community member before proceeding to implement a
6767
feature or patch. This is particularly important for [significant
68-
changes](https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.rst#write-designs-for-significant-changes),
68+
changes](https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.md#write-designs-for-significant-changes),
6969
and will typically be labeled during triage with `needs design`.
7070

7171
After you have agreed upon an implementation strategy for your feature
7272
or patch with an MLflow committer, the next step is to introduce your
7373
changes (see [developing
74-
changes](https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.rst#developing-and-testing-mlflow))
74+
changes](https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.md#developing-and-testing-mlflow))
7575
as a pull request against the MLflow Repository (we recommend pull
7676
requests be filed from a non-master branch on a repository fork) or as a
7777
standalone MLflow Plugin. MLflow committers actively review pull

README.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ Start it with::
116116
**Note:** Running ``mlflow ui`` from within a clone of MLflow is not recommended - doing so will
117117
run the dev UI from source. We recommend running the UI from a different working directory,
118118
specifying a backend store via the ``--backend-store-uri`` option. Alternatively, see
119-
instructions for running the dev UI in the `contributor guide <CONTRIBUTING.rst>`_.
119+
instructions for running the dev UI in the `contributor guide <CONTRIBUTING.md>`_.
120120

121121

122122
Running a Project from a URI
@@ -150,4 +150,4 @@ Contributing
150150
------------
151151
We happily welcome contributions to MLflow. We are also seeking contributions to items on the
152152
`MLflow Roadmap <https://github.com/mlflow/mlflow/milestone/3>`_. Please see our
153-
`contribution guide <CONTRIBUTING.rst>`_ to learn more about contributing to MLflow.
153+
`contribution guide <CONTRIBUTING.md>`_ to learn more about contributing to MLflow.

docs/theme/mlflow/side_nav.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
{% include "build_info.html" %}
4141

4242
<p>
43-
<a id='feedbacklink' href="https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.rst" target="_blank">Contribute</a>
43+
<a id='feedbacklink' href="https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.md" target="_blank">Contribute</a>
4444
</p>
4545
</div>
4646
</div>

mlflow/R/mlflow/README.Rmd

+1-1
Original file line numberDiff line numberDiff line change
@@ -242,4 +242,4 @@ To enable fast iteration while tracking with MLflow improvements over a model, [
242242

243243
## Contributing
244244

245-
See the [MLflow contribution guidelines](../../../CONTRIBUTING.rst).
245+
See the [MLflow contribution guidelines](../../../CONTRIBUTING.md).

mlflow/R/mlflow/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -291,4 +291,4 @@ follows:
291291

292292
## Contributing
293293

294-
See the [MLflow contribution guidelines](https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.rst).
294+
See the [MLflow contribution guidelines](https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.md).

mlflow/server/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ def serve():
8282
8383
If you are a developer making MLflow source code changes and intentionally running a source
8484
installation of MLflow, you can view the UI by running the Javascript dev server:
85-
https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.rst#running-the-javascript-dev-server
85+
https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.md#running-the-javascript-dev-server
8686
8787
Otherwise, uninstall MLflow via 'pip uninstall mlflow', reinstall an official MLflow release
8888
from PyPI via 'pip install mlflow', and rerun the MLflow server.

mlflow/store/db_migrations/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This directory contains configuration scripts and database migration logic for MLflow tracking
44
databases, using the Alembic migration library (https://alembic.sqlalchemy.org). To run database
55
migrations, use the ``mlflow db upgrade`` CLI command. To add and modify database migration logic,
6-
see the contributor guide at https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.rst.
6+
see the contributor guide at https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.md.
77

88
If you encounter failures while executing migrations, please file a GitHub issue at
99
https://github.com/mlflow/mlflow/issues.

tests/tracking/_model_registry/test_utils.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
# Disable mocking tracking URI here, as we want to test setting the tracking URI via
1616
# environment variable. See
1717
# http://doc.pytest.org/en/latest/skipping.html#skip-all-test-functions-of-a-class-or-module
18-
# and https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.rst#writing-python-tests
18+
# and https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.md#writing-python-tests
1919
# for more information.
2020
pytestmark = pytest.mark.notrackingurimock
2121

tests/tracking/_tracking_service/test_utils.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
# Disable mocking tracking URI here, as we want to test setting the tracking URI via
3333
# environment variable. See
3434
# http://doc.pytest.org/en/latest/skipping.html#skip-all-test-functions-of-a-class-or-module
35-
# and https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.rst#writing-python-tests
35+
# and https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.md#writing-python-tests
3636
# for more information.
3737
pytestmark = pytest.mark.notrackingurimock
3838

0 commit comments

Comments
 (0)