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

chore: Update contributing docs #1419

Merged
merged 13 commits into from
Jul 23, 2024

Conversation

alimpens
Copy link
Contributor

@alimpens alimpens commented Jul 19, 2024

Describe the pull request

What

Updates to CONTRIBUTING.md

Why

To make it clearer how users can open an issue and submit a PR

How

By following an existing CONTRIBUTING.md template.

Checklist

Before submitting your pull request, please ensure you have done the following. Check each checkmark if you have done so or if it wasn't necessary:

  • Add or update unit tests
  • Add or update documentation
  • Add or update stories
  • Add or update exports in index.* files
  • Start the PR title with a Conventional Commit prefix, as explained here.

Additional notes

@github-actions github-actions bot temporarily deployed to demo-DES-720-update-contributing July 19, 2024 07:58 Destroyed
Copy link
Contributor

@VincentSmedinga VincentSmedinga left a comment

Choose a reason for hiding this comment

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

Great effort, lots of essential knowledge in here. I have some suggestions on specific sentences.

I am a bit worried about the usability of the document. On GitHub, it looks like this – the various lengths of sections, lists and underlines make it appear a bit messy. Although I don’t see an easy way out. I’d be fine with the current state as a good start.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@github-actions github-actions bot temporarily deployed to demo-DES-720-update-contributing July 23, 2024 12:28 Destroyed
@github-actions github-actions bot temporarily deployed to demo-DES-720-update-contributing July 23, 2024 12:30 Destroyed
@github-actions github-actions bot temporarily deployed to demo-DES-720-update-contributing July 23, 2024 12:38 Destroyed
@github-actions github-actions bot temporarily deployed to demo-DES-720-update-contributing July 23, 2024 12:40 Destroyed
@github-actions github-actions bot temporarily deployed to demo-DES-720-update-contributing July 23, 2024 12:45 Destroyed
@github-actions github-actions bot temporarily deployed to demo-DES-720-update-contributing July 23, 2024 12:58 Destroyed
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@github-actions github-actions bot temporarily deployed to demo-DES-720-update-contributing July 23, 2024 21:36 Destroyed
@VincentSmedinga VincentSmedinga merged commit cf2e8aa into develop Jul 23, 2024
6 checks passed
@VincentSmedinga VincentSmedinga deleted the task/DES-720-update-contributing branch July 23, 2024 21:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants