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

599-update gitignore #622

Merged
merged 5 commits into from
Aug 28, 2024
Merged

599-update gitignore #622

merged 5 commits into from
Aug 28, 2024

Conversation

lyashevska
Copy link
Member

Checklist before requesting a review

  • I have read the contribution guidelines
  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • All user facing changes have been added to CHANGELOG.md

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)

List of related issues or pull requests**

Refs:

Describe the changes made in this pull request

Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.

Instructions to review the pull request

Install the requirements

cd $(mktemp -d --tmpdir py-tmpl-XXXXXX)
pip install pipx
pipx install copier

Create a new package using the template

copier copy --vcs-ref <YOUR_BRANCH> https://github.com/nlesc/python-template test_package

Create a local git repo to push to GitHub to trigger CI actions

git init
git add --all
git commit -m "First commit"
git remote add origin [email protected]:<YOU>/python-template-test.git
git push -u origin main -f
# Create a local environment to test your generated package locally
python -m venv env
source env/bin/activate
python -m pip install --upgrade pip setuptools
python -m pip install '.[dev,publishing]'

template/.gitignore Outdated Show resolved Hide resolved
template/.gitignore Outdated Show resolved Hide resolved
Copy link
Member

@fdiblen fdiblen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have made two minor suggestions.

Copy link
Member

@fdiblen fdiblen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good! 🍝

@lyashevska lyashevska merged commit caf8c92 into main Aug 28, 2024
18 checks passed
@lyashevska lyashevska deleted the 599-gitignore branch August 28, 2024 16:24
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.

2 participants