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

Feature/update_cookiecutter #20

Merged
merged 30 commits into from
Feb 10, 2024
Merged

Feature/update_cookiecutter #20

merged 30 commits into from
Feb 10, 2024

Conversation

JoseRZapata
Copy link
Owner

@JoseRZapata JoseRZapata commented Feb 10, 2024

Add mkdocs, codevod and git init

✨ Context

IN order to update the template, in needed to add git initialization, mkdocs and codecov as variables in the cookie cutter init

🧠 Rationale behind the change

Set git at the beginning of the proyect is good practice in software, and give the option to install mkdocs and codecov

Type of changes

  • ✨ New Feature (changes that introduce new functionality)
  • πŸ’₯ Breaking Change (Changes that radically modify current behavior and may be problematic)
  • πŸ“ Documentation
  • πŸ”₯ Improvements (Minor refactoring, code changes or optimizations)
  • πŸ‘· πŸ”§ CI or Configuration Files

πŸ›  What does this PR implement

  • pull_request_template.md: add emojis to info
  • setup_tokens.md info how to setup github secrets and codecov token
  • post_gen_proyect.py: project git init and mkdocs and codecov as an option
  • ruff.tomlfix lint options
  • docs.yml and test.ymladd github actions tto create documentation and test code
  • Makefile update command to install libs to only one
  • cookiecutter.jsonupdate with new options and promot info

Remove jupyter option from cookiecutter, update information in README files

Upadte project information and add mkdocs setup tokens.

πŸ™ˆ Missing

Create unit test to the template

πŸ§ͺ How should this be tested?

Manually tested

@JoseRZapata JoseRZapata self-assigned this Feb 10, 2024
@JoseRZapata JoseRZapata marked this pull request as ready for review February 10, 2024 22:59
@JoseRZapata JoseRZapata merged commit 68605dd into main Feb 10, 2024
@JoseRZapata JoseRZapata deleted the feature/update_cookiecutter branch February 10, 2024 23:00
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

Successfully merging this pull request may close these issues.

None yet

1 participant