Document the setup questions #85
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
drewoldag
reviewed
Mar 10, 2023
docs/source/new_project.rst
Outdated
| * *What is your python module name?* (``module_name``): The name of your (first) module. The main thing this controls is where your source code will live (``src/{{module_name}}``). | ||
| * *Your first and last name?* (``author_name``): The name of code's author. This will be used in the project and documentation metadata. | ||
| * *Your preferred email address?* (``author_email``): The contact email for the code's author. This will be used in the project and documentation metadata. | ||
| * *What tooling would you like to use to enforce code style?* (``preferred_linter``): A linter is a tool to automatically format for consistency (see :doc:`Linting <../practices/linting>`). We provide options for `black <https://black.readthedocs.io/en/stable/>`_, `pylint <https://pypi.org/project/pylint/>`_, or no linter. Choosing a linter will include it as a project dependency and include it in the pre commit hooks. |
Collaborator
There was a problem hiding this comment.
We have a :doc: for pre-commit that might be nice to link to here. Not sure how well known pre-commit is in the astro community.
drewoldag
approved these changes
Mar 10, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Document the setup questions, how they are used, and what to do if you want to change answers later.
Also provide a bit more background on virtual environments for users who might not have worked with them before.