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

[ENHANCEMENT] Cookiecutter-like for creating new repositories #15

Open
orviz opened this issue Feb 18, 2019 · 5 comments
Open

[ENHANCEMENT] Cookiecutter-like for creating new repositories #15

orviz opened this issue Feb 18, 2019 · 5 comments
Assignees
Labels
annex Elaborated requirements that do not fit in the main baseline enhancement New addition

Comments

@orviz
Copy link
Member

orviz commented Feb 18, 2019

Please elaborate here on the enhancement request.
When running projects involving software developments, managers usually face the need of creating new products (tools/apps) to complement the current software stack. In those cases having a script to create new code repositories with the default/required minimal files is a good practice.

Describe the solution you'd like
Include in the guidelines a recommendation/best practice for managing software projects: defining the structure of the files that need to exist in each code repository AND enforce it with a template generator (such as cookiecutter)

Additional context
Python's Cookiecutter

@orviz orviz added the enhancement New addition label Feb 18, 2019
@orviz orviz self-assigned this Feb 18, 2019
@orviz
Copy link
Member Author

orviz commented Feb 27, 2019

Sample files could be:

  • If Jenkins:
    • Jenkinsfile
    • git hooks (e.g. pre-commit Jenkinsfile's linter)
  • If Python:
    • tox.ini
    • requirements.txt
    • test-requirements.txt

@mariojmdavid
Copy link
Contributor

RECOMMENDATION / SHOULD
I think it SHOULD be left from the main text, the examples: python, Cookiecutter, jenkin(file), tox etc.

@orviz
Copy link
Member Author

orviz commented Mar 27, 2019

@mariojmdavid Totally agree with leaving it apart from the main text. We should agree in the best way to do this, I suggest to proceed using Annexes, like in #7

@orviz
Copy link
Member Author

orviz commented Mar 27, 2019

I have created a "move to annex" label for this type of requirements.

@orviz orviz added the annex Elaborated requirements that do not fit in the main baseline label Mar 27, 2019
@mariojmdavid mariojmdavid added the v4.0 release v4.0 label Sep 20, 2020
@mariojmdavid mariojmdavid added v4.1 and removed v4.0 release v4.0 labels Nov 3, 2021
@mariojmdavid mariojmdavid added question Further information is requested and removed v4.1 labels Jun 17, 2022
@mariojmdavid
Copy link
Contributor

we may have a new Annex called recommendations as a best practice to achieve the SQA in a more streamlined manner
the tag "question" is for further discussion, and don't know if we will include this in the next release

@mariojmdavid mariojmdavid removed the question Further information is requested label Jun 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
annex Elaborated requirements that do not fit in the main baseline enhancement New addition
Projects
None yet
Development

No branches or pull requests

2 participants