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

Move contributing and developer docs to recommended #339

Merged
merged 1 commit into from
Jul 8, 2024

Conversation

abelsiqueira
Copy link
Owner

These files are overkill for a minimal case. They can, in the
future, come back as simpler versions on the minimal case. However,
thinking about, for instance, a solo dev kickstarting the package and
using the minimal (so no formatter, no issue templates, no linting), it
won't make sense to have all these guidelines in place.

Closes #313

Breaking change: If you have are using the minimal version, this will
remove the files docs/src/90-contributing.md and
docs/src/91-developer.md.

These files are overkill for a minimal case. They can, in the
future, come back as simpler versions on the minimal case. However,
thinking about, for instance, a solo dev kickstarting the package and
using the minimal (so no formatter, no issue templates, no linting), it
won't make sense to have all these guidelines in place.

Closes #313

Breaking change: If you have are using the minimal version, this will
remove the files docs/src/90-contributing.md and
docs/src/91-developer.md.
Copy link

codecov bot commented Jul 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (d05e649) to head (5742796).

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #339   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines           57        57           
=========================================
  Hits            57        57           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@abelsiqueira abelsiqueira merged commit 56ef2bb into main Jul 8, 2024
7 checks passed
@abelsiqueira abelsiqueira deleted the 313-dev-docs-question branch July 8, 2024 10:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Move contributing and developer to recommended
1 participant