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

Document handling of optional dependencies #593

Merged
merged 3 commits into from
Feb 17, 2022

Conversation

nipafx
Copy link
Member

@nipafx nipafx commented Feb 16, 2022

Commit message comes later...


PR checklist

The following checklist shall help the PR's author, the reviewers and maintainers to ensure the quality of this project.
It is based on our contributors guidelines, especially the "writing code" section.
It shall help to check for completion of the listed points.
If a point does not apply to the given PR's changes, the corresponding entry can be simply marked as done.

Documentation (general)

  • There is documentation (Javadoc and site documentation; added or updated)
  • Only one sentence per line (especially in .adoc files)
  • Javadoc uses formal style, while sites documentation may use informal style

Code

  • There are checks which validate correct / false usage / configuration of a functionality and there are tests to verify those checks

Contributing

  • A prepared commit message exists

I hereby agree to the terms of the JUnit Pioneer Contributor License Agreement.

@nipafx nipafx linked an issue Feb 16, 2022 that may be closed by this pull request
CONTRIBUTING.md Outdated Show resolved Hide resolved
.infra/checkstyle/import-control.xml Show resolved Hide resolved
Because WE can commit to Nicolai's PR! Not just the other way around!

Co-authored-by: Daniel Kraus <daniel.kraus@mailbox.org>
@Michael1993
Copy link
Member

Proposed commit message:

Document optional dependency policy #576 / #580

Update CONTRIBUTING.md with the new policy regarding optional dependencies in Pioneer.

Closes: #502
PR: #593

@nipafx
Copy link
Member Author

nipafx commented Feb 16, 2022

Just a heads-up: I want to include much of the exploration done in #502 into the commit message, so please don't merge this yet.

@nipafx nipafx added the full-build Triggers full build suite on PR label Feb 16, 2022
@nipafx nipafx merged commit 49331aa into main Feb 17, 2022
@nipafx nipafx deleted the issue/502-optional-dependencies branch February 17, 2022 09:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
full-build Triggers full build suite on PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Discuss approach to optional dependencies
3 participants