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

doc: add submodule policy in CONTRIBUTING.md #4930

Merged
merged 2 commits into from
Oct 9, 2022
Merged

Conversation

monperrus
Copy link
Collaborator

No description provided.

@sonatype-lift
Copy link
Contributor

sonatype-lift bot commented Sep 29, 2022

⚠️ 85 God Classes were detected by Lift in this project. Visit the Lift web console for more details.

Copy link
Collaborator

@slarse slarse left a comment

Choose a reason for hiding this comment

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

I think it'd be appropriate to at least mention that we don't publish submodules?

CONTRIBUTING.md Show resolved Hide resolved
Co-authored-by: Simon Larsén <slarse@slar.se>
@monperrus
Copy link
Collaborator Author

agree. merged suggestion.

Copy link
Collaborator

@slarse slarse left a comment

Choose a reason for hiding this comment

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

This is good for me.

@SirYwell @I-Al-Istannen @MartinWitt anything to add? I think the CONTRIBUTING.md file is pretty important so I don't want to merge without you getting the chance to say your piece.

@MartinWitt
Copy link
Collaborator

I thought about adding a hint for jitpack.io, but sadly this is pretty unstable and no one should use this for production code. So lgtm you can merge.

@I-Al-Istannen
Copy link
Collaborator

I have found jitpack to be quite reliable for other projects, but users can probably find something nice on their own here.

@slarse
Copy link
Collaborator

slarse commented Oct 9, 2022

I also think that Jitpack is a little bit beyond the scope of these docs (although I concur with @I-Al-Istannen in that I've found it to be reliable when I've used it).

Merging this now so we get it in, we can always update it later!

@slarse
Copy link
Collaborator

slarse commented Oct 9, 2022

Thanks @monperrus

@slarse slarse merged commit 999e4dd into master Oct 9, 2022
@slarse slarse deleted the monperrus-patch-3 branch October 9, 2022 18:48
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.

4 participants