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

docs(readme): split guidelines #30

Merged
merged 3 commits into from
Jul 11, 2024
Merged

docs(readme): split guidelines #30

merged 3 commits into from
Jul 11, 2024

Conversation

cmdoret
Copy link
Member

@cmdoret cmdoret commented Jul 11, 2024

Proposed Changes

Simplifies the readme by splitting specialized sections into dedicated documentation pages.

Types of Changes

What types of changes does your code introduce? Put an x in the boxes that
apply

  • A bug fix (non-breaking change which fixes an issue).
  • A new feature (non-breaking change which adds functionality).
  • A breaking change (fix or feature that would cause existing
    functionality to not work as expected).
  • A non-productive update (documentation, tooling, etc. if none of the
    other choices apply).

Checklist

Put an x in the boxes that apply. You can also fill these out after creating
the PR. If you're unsure about any of them, don't hesitate to ask. We're here to
help! This is simply a reminder of what we are going to look for before merging
your code.

  • I have read the
    CONTRIBUTING
    guidelines.
  • I have added tests that prove my fix is effective or that my feature
    works.
  • I have added the necessary documentation (if appropriate).

Further Comments

This also includes a fix to correctly render the CI badge in the readme.

@cmdoret cmdoret self-assigned this Jul 11, 2024
@cmdoret cmdoret added the documentation Improvements or additions to documentation label Jul 11, 2024
@cmdoret cmdoret merged commit f1bfa08 into main Jul 11, 2024
7 checks passed
@cmdoret cmdoret deleted the docs/split-guidelines branch July 11, 2024 17:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant