Skip to content

Add steps for ensuring pre-commit hooks are installed #416

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

Merged
merged 28 commits into from
Sep 30, 2024

Conversation

dragid10
Copy link
Member

@dragid10 dragid10 commented Sep 16, 2024

Added steps for running tests and pre-commit linters/formatters.

Additions:

  • Add more explicit steps for installing dependencies (codespace and local)
  • Add steps for explicitly installing pre-commit hooks (codespace and local)
  • Add explicit steps for committing and pushing to GitHub
  • Added screenshots for instructions added

Changes:

  • Make command for starting jekyll server run in background
    • Since bundle exec is greedy and steals the terminal from the user, we send it to the background so that the user can then run other commands easily

Closes #351

@dragid10 dragid10 marked this pull request as ready for review September 22, 2024 00:15
@dragid10 dragid10 marked this pull request as draft September 22, 2024 16:27
@dragid10 dragid10 marked this pull request as ready for review September 30, 2024 03:40
@dragid10
Copy link
Member Author

Okay lots of commits later (we should definitely do a squash and merge for this one), and it is finally ready for review! @kjaymiller

README.md Outdated
Follow these steps and note these guidelines to begin contributing:

1. First step is to set up the local development environment.
1. Bug fixes are always welcome. Start by reviewing the [list of bugs](https://github.com/BlackPythonDevs/blackpythondevs.github.io/issues).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
1. Bug fixes are always welcome. Start by reviewing the [list of bugs](https://github.com/BlackPythonDevs/blackpythondevs.github.io/issues).
2. Bug fixes are always welcome. Start by reviewing the [list of bugs](https://github.com/BlackPythonDevs/blackpythondevs.github.io/issues).

README.md Outdated

1. First step is to set up the local development environment.
1. Bug fixes are always welcome. Start by reviewing the [list of bugs](https://github.com/BlackPythonDevs/blackpythondevs.github.io/issues).
1. A good way to easily start contributing is to pick and work on a [good first issue](https://github.com/BlackPythonDevs/blackpythondevs.github.io/labels/good%20first%20issue). We try to make these issues as clear as possible and provide basic info on how the code should be changed, and if something is unclear feel free to ask for more information on the issue.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
1. A good way to easily start contributing is to pick and work on a [good first issue](https://github.com/BlackPythonDevs/blackpythondevs.github.io/labels/good%20first%20issue). We try to make these issues as clear as possible and provide basic info on how the code should be changed, and if something is unclear feel free to ask for more information on the issue.
3. A good way to easily start contributing is to pick and work on a [good first issue](https://github.com/BlackPythonDevs/blackpythondevs.github.io/labels/good%20first%20issue). We try to make these issues as clear as possible and provide basic info on how the code should be changed, and if something is unclear feel free to ask for more information on the issue.

README.md Outdated
Copy link
Contributor

Choose a reason for hiding this comment

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

Great work on breaking this information down. One thing I would like to do is move these steps into CONTRIBUTING.md.

Copy link
Contributor

Choose a reason for hiding this comment

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

@dragid10 - should it take 30 minutes? I don't think I've seen it take that long ever

Copy link
Member Author

Choose a reason for hiding this comment

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

I doubt it would, but as I was testing some changes on the GH actions, I found out that it has a very long (or no) timeout. So if something funky starts happening, then I'd like to kill the actions job in a reasonable amount of time

Copy link
Contributor

Choose a reason for hiding this comment

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

I would consider like maybe 10 minutes then. I really don't imaging it getting much longer than that (of course until it does)

Copy link
Contributor

@kjaymiller kjaymiller Sep 30, 2024

Choose a reason for hiding this comment

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

but that can be added in a new issue. Great work on this one!

@kjaymiller kjaymiller merged commit 56e317b into BlackPythonDevs:gh-pages Sep 30, 2024
2 checks passed
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.

Improve the Contributing section around testing your changes
2 participants