Update CONTRIBUTING.md #4798

Innixma · 2025-01-15T00:47:03Z

Issue #, if available:

Description of changes:

Update CONTRIBUTING.md to be up to date and provide additional useful information

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

github-actions · 2025-01-15T03:53:31Z

Job PR-4798-a7dfb58 is done.
Docs are uploaded to http://autogluon-staging.s3-website-us-west-2.amazonaws.com/PR-4798/a7dfb58/index.html

shchur

A few comments but otherwise LGTM

CONTRIBUTING.md

shchur · 2025-01-15T08:32:32Z

CONTRIBUTING.md


 To send us a pull request, please:

-1. Fork the repository.
+1. Fork the repository and clone the source code to your local machine.


Should we add pointers to the official GitHub docs on forking & cloning?

great idea, added

shchur · 2025-01-15T08:33:08Z

CONTRIBUTING.md


 To send us a pull request, please:

-1. Fork the repository.
+1. Fork the repository and clone the source code to your local machine.
 2. Modify the source (see details below); please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
 3. Ensure local tests pass.


Do we have an example showing which tests need to pass?

removed reference to tests since it would take too long for them to run

shchur · 2025-01-15T08:34:53Z

CONTRIBUTING.md

 2. Modify the source (see details below); please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
 3. Ensure local tests pass.
 4. Commit to your fork using clear commit messages.
 5. Send us a pull request, answering any default questions in the pull request interface.
 6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
-7. To spin up the platform tests, which test autogluon among macos and windows, comment on the PR with `/platform_tests`(You would need write permission to AutoGluon repo). It is recommended to run the platform tests only after you have passed the default CI.
+7. (Optional) To spin up the platform tests, which test autogluon among MacOS and Windows, comment on the PR with `/platform_tests`(You would need write permission to AutoGluon repo). It is recommended to run the platform tests only after you have passed the default CI and only for changes that are likely to cause platform specific issues.


IIRC, one can only start platform tests from a branch of the autogluon/autogluon repo and not for branches of the forks. It makes sense for us (maintainers) to be aware of this, but probably not something for the users to worry about since they cannot run the tests.

Good point, moved to a different section focusing on maintainer specific contribution instructions

shchur · 2025-01-15T08:38:55Z

CONTRIBUTING.md

@@ -69,10 +70,51 @@ cd ../multimodal/
 pytest
 cd ../timeseries/
 pytest


Lines 61-72 could be replaced with

pytest common/tests pytest core/tests ...

nice, updated

shchur · 2025-01-15T08:49:30Z

CONTRIBUTING.md

+# the below will check for changes that will occur if performing linting
+
+# black
+ruff format --diff "timeseries/"
+# isort
+ruff check --select I "timeseries/"
+
+# black
+ruff format --diff "common/"
+# isort
+ruff check --select I "common/"
+
+# black
+ruff format --diff "features/"
+# isort
+ruff check --select I "features/"
+```


Maybe the following is shorter / more readable?

# Check formatting and the order of imports for dir in "timeseries" "common" "features"; do ruff format --diff $dir ruff check --select I $dir done

These checks don't technically perform linting, only style checks (formatting and import sorting). Linting would be done with ruff check $dir and that's only enabled for timeseries (equivalent to flake8).

good point, updated and changed wording

shchur · 2025-01-15T08:50:16Z

CONTRIBUTING.md

+# the below will actively change files to satisfy linting
+# DO NOT run the below commands before running the above commands, as you risk introducing many unintended changes.
+
+# black
+ruff format "timeseries/"
+# isort
+ruff check --fix  --select I "timeseries/"
+
+# black
+ruff format "common/"
+# isort
+ruff check --fix  --select I "common/"
+
+# black
+ruff format "features/"
+# isort
+ruff check --fix --select I "features/"
+```


Same here

for dir in "timeseries" "common" "features"; do ruff format $dir ruff check --fix --select I $dir done

updated thanks

shchur · 2025-01-15T08:52:36Z

CONTRIBUTING.md

-
- After you open your pull request, our CI system will run for little while to check your code and report found errors. Please check back and fix any errors encountered at this stage (you can retrigger a new CI check by pushing updated code to the same PR in a new commit).
-
+- We also encourage you to contribute new tutorials or example scripts using AutoGluon for applications you think other users will be interested in. Please see [`docs/tutorials/`](https://github.com/autogluon/autogluon/tree/master/docs/tutorials) or [`examples/`](https://github.com/autogluon/autogluon/tree/master/examples). All tutorials should be Jupyter notebooks (.ipynb) files.


Side note: Is our examples folder up-to-date / maintained?

almost certainly not, will remove the mention here.

shchur · 2025-01-15T08:53:08Z

CONTRIBUTING.md


+- After you open your pull request, our CI system will run to check your code and report found errors. This may take a few hours. Please check back and fix any errors encountered at this stage (you can retrigger a new CI check by pushing updated code to the same PR in a new commit).


The maintainers would need to approve the CI run first.

shchur · 2025-01-15T08:55:19Z

CONTRIBUTING.md

 ```

+- Lint the code, so it adheres to our code style by running the below command. Note that our lint check for tabular, core, and multimodal modules are temporarily disabled.


Should we enable linting & style checks for these modules now that we are done with v1.2.0?

Yeah, I plan to soonish, once some of the old PRs are merged (working on it)

Co-authored-by: Oleksandr Shchur <oleks.shchur@gmail.com>

github-actions · 2025-01-15T22:31:36Z

Job PR-4798-6c9071c is done.
Docs are uploaded to http://autogluon-staging.s3-website-us-west-2.amazonaws.com/PR-4798/6c9071c/index.html

Update CONTRIBUTING.md

484d2bb

Innixma added this to the 1.3 Release milestone Jan 15, 2025

Innixma requested a review from shchur January 15, 2025 00:47

Update CONTRIBUTING.md

a7dfb58

shchur approved these changes Jan 15, 2025

View reviewed changes

shchur reviewed Jan 15, 2025

View reviewed changes

Innixma and others added 2 commits January 15, 2025 10:47

Update CONTRIBUTING.md

6878121

Co-authored-by: Oleksandr Shchur <oleks.shchur@gmail.com>

Address comments

6c9071c

Innixma merged commit 4179ea2 into autogluon:master Jan 15, 2025
2 checks passed

Innixma deleted the update_contrib branch April 16, 2025 21:18


		- After you open your pull request, our CI system will run for little while to check your code and report found errors. Please check back and fix any errors encountered at this stage (you can retrigger a new CI check by pushing updated code to the same PR in a new commit).

		- We also encourage you to contribute new tutorials or example scripts using AutoGluon for applications you think other users will be interested in. Please see [`docs/tutorials/`](https://github.com/autogluon/autogluon/tree/master/docs/tutorials) or [`examples/`](https://github.com/autogluon/autogluon/tree/master/examples). All tutorials should be Jupyter notebooks (.ipynb) files.

		```

		- Lint the code, so it adheres to our code style by running the below command. Note that our lint check for tabular, core, and multimodal modules are temporarily disabled.

Update CONTRIBUTING.md #4798

Update CONTRIBUTING.md #4798

Uh oh!

Conversation

Innixma commented Jan 15, 2025

Uh oh!

github-actions bot commented Jan 15, 2025

Uh oh!

shchur left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shchur Jan 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Jan 15, 2025

Uh oh!

Uh oh!

shchur Jan 15, 2025 •

edited

Loading