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 CONTRIBUTING.md instructions #5

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

Conversation

aarhusgregersen
Copy link

Updated the text for a header to more accurately reflect the contents in that block

πŸ”— Linked issue

No linked issue AFAIK.

❓ Type of change

  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)
  • πŸ“˜ Documentation

πŸ“š Description

I found the contribution docs a little confusing myself, as it went directly into cloning the repository, without any prior explanation of how the contribution setup should look like (fork it first).
Additionally I found that the header for "Creating pull requests" doesn't accurately reflect the intention of that title (at least I read it as '(how) creating pull requests (is done)'.

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

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