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

Update README.md #627

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #627

wants to merge 1 commit into from

Conversation

jesperhodge
Copy link
Member

The commit d5e5171 removed the make command docker_build from the Makefile.

When setting up the repo, the first step in the README is to run docker_build, which results in a confusing error.
Skipping that step works just fine, so I'm removing it from the README.

Copy link
Contributor

@bcitro bcitro left a comment

Choose a reason for hiding this comment

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

Thanks for fixing this Jesper! You'll just need to update your commit message to conform with Conventional Commits to get that linter check to pass. In this case, you just need to add the type of the commit to the beginning, which should be docs:.

More info here: https://open-edx-proposals.readthedocs.io/en/latest/best-practices/oep-0051-bp-conventional-commits.html

@jesperhodge jesperhodge force-pushed the fix-readme-outdated-setup-step branch from f756c0f to 2101a34 Compare January 30, 2025 15:52
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