question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

CONTRIBUTING files are referencing nox --session=black

See original GitHub issue

The two CONTRIBUTING.rst file in this repo are refferencing the command `nox --session=black``

This session name doesn’t exist in any noxfile.py in the repo. The documentation needs update.

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:7 (7 by maintainers)

github_iconTop GitHub Comments

1reaction
oncleben31commented, Aug 1, 2020

OK we are aligned. I will work on the PR soon.

0reactions
cjolowiczcommented, Aug 1, 2020

Oh, I just realized that you’re right: the generated project does not have any information about how to install the pre-commit hook. This information is only present in the User Guide of the Cookiecutter template, which is not linked anywhere from the generated project.

So then yes 💯 ! Please do add a short note to the Contributor Guide ({{cookiecutter.project_name}}/CONTRIBUTING.rst}}). I would suggest to add something like the following instead of the note about nox --session=black:

Install pre-commit as a Git hook by running the following command:

.. code:: console

   $ nox --session=pre-commit -- install
Read more comments on GitHub >

github_iconTop Results From Across the Web

PrivacyRaven/noxfile.py at master
noxfile.py. import tempfile. import nox. package = "privacyraven". nox.options.sessions = "tests", "lint", "black", "isort".
Read more >
Changelog — Nox 2022.11.21 documentation
Nox's configuration file is now called noxfile.py instead of nox.py . Nox no longer supports Python 2.7. You can still create and run...
Read more >
Reference - nox-poetry documentation
This package provides a drop-in replacement for the session() decorator, and for the Session object passed to user-defined session functions. This enables ...
Read more >
RFP-12-NOx-and-SOx-Contributions-to-PM2.5.pdf
CONCEPTUAL MODEL FOR NOx AND SOx CONTRIBUTIONS TO PM2.5 ... one (1) unbound master suitable for black and white reproduction; and.
Read more >
BLACK CARBON MITIGATION AND THE ROLE OF THE ...
This document benefited greatly from the contributions of Patrick Kinney (Columbia ... CITATION. Sims, R., V. Gorsevski and S. Anenberg (2015). Black Carbon ......
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found