search

dmlc / xgboost

Scalable, Portable and Distributed Gradient Boosting (GBDT, GBRT or GBM) Library, for Python, R, Java, Scala, C++ and more. Runs on single machine, Hadoop, Spark, Dask, Flink and DataFlow
https://xgboost.readthedocs.io/en/stable/
Apache License 2.0
26.14k stars 8.71k forks source link

Docs for 'contributing' are missing section to run R linter #10455

Closed david-cortes closed 1 month ago

david-cortes commented 3 months ago

There is a section in the docs for running formatters locally: https://xgboost.readthedocs.io/en/stable/contrib/coding_guide.html#running-formatting-checks-locally

which has instructions for running the Python linter and the C++ linter, but it doesn't have instructions for running the R linter which is checked in the CI jobs.

It doesn't seem to be a simple matter of executing the file tests/ci_build/lint_r.R, since it requires command line arguments to run.

Would be ideal to have instructions there about how to run the R linter too.

trivialfis commented 3 months ago

Apologies for the lack of the document. For now, please use the github CI as a reference: https://github.com/dmlc/xgboost/blob/2b400b18d5d4719422ff1e37bfdb22a55cc1eb78/.github/workflows/r_tests.yml#L48