Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add suggestions for customizing a new project based on this template #26

Open
garrison opened this issue Feb 16, 2022 · 1 comment
Open

Comments

@garrison
Copy link
Member

What is the expected enhancement?

Although this template is rather minimalist, a user creating a new project might want to spend a few minutes at the very beginning trimming it down further. Let's make a file (e.g. docs/ideas-for-trimming.md) which contains suggestions for such trimming. Some ideas it could include:

  • disable pylint (and possibly black) early on in a project's development; re-enable it later once development matures a bit
  • remove qiskit from requirements.txt if the project does not depend on qiskit
  • remove docs/images/logo.png
  • remove ideas-for-trimming.md itself and any other files which are specific to the template
@garrison garrison changed the title Add suggestions for "trimming" a new project based on this template Add suggestions for customizing a new project based on this template Feb 21, 2022
@garrison
Copy link
Member Author

garrison commented Feb 21, 2022

I've broadened this issue to include all aspects of customization when the initial project is created. Before trimming, one should typically run git grep (or even a platform-independent sed invocation) to identify links and identifiers that should be updated, and also move some files to their intended destinations (e.g. the prototype_template directory).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant