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

Complete crosslink between OSSF and InnerSource Commons SCM guidance #557

Open
JustinGOSSES opened this issue Jul 1, 2024 · 6 comments
Open

Comments

@JustinGOSSES
Copy link

Hi! I want to get some feedback before submitting a PR. This is directed at the Source-Code-Best-Practices content

The InnerSource Commons (ISC) is a foundation that "is a thriving community that empowers organizations and people worldwide to apply and gain the benefits of open collaboration in their internal work."

One of the recent projects of the ISC is content related to managing InnerSource at the program level, currently being integrated into a pre-existing GitBook. Part of that effort is guidance on source code management (SCM) for internal only code platforms. Currently, only GitHub is covered but there's a GitLab version in the works. The SCM section in the Git book has a
a link https://innersourcecommons.gitbook.io/managing-innersource-projects/innersource-tooling to the OSSF SCM guidance .

We also encourage you to read the OSSF's (Open Source Security Foundation's) [Source Code Management Configuration Best Practices guide](https://best.openssf.org/SCM-BestPractices/) for a perspective focused entirely on security.

Would the ossf/wg-best-practices-os-developers repo be willing to cross link back to the ISC SCM guidance document as we have linked to yours?

There's a lot of overlap between the two guidance docs but also different perspectives taken, which I think is valuable. While OSSF's guidance focuses on individual settings and seems to imagine a scenario where a single instance is used for both public facing code and internal code, ISC's guidance focuses on layering settings and imagines a scenario where a single instance is only used for internal code.

I could imagine the cross-link being placed either in the first paragraph of the OSSF SCM guidance, similar to what is done on the ISC side, or as an additional section at the bottom of the page after all the guidance that's titled "Other perspectives" or something similar.

@david-a-wheeler
Copy link
Contributor

Quick note, the official abbreviation for the Open Source Security Foundation is "OpenSSF" not "OSSF".

When we cite specific items (e.g., to give credit), we of course include citations.

As far as a general cross-link, we tend to hesitate if it's a for-profit organization, but it appears this is a non-profit. I'll ask & see if we have some policy against it; I don't know of one, but that probably should be checked. We have a lot of contributing organizations & we don't want to be unfair to any.

@JustinGOSSES
Copy link
Author

Thanks for the quick response. I'll correct that acronym spelling on the InnerSource Commons side.

Yep, totally makes sense to check for existence of a cross-linking policy.

@SecurityCRob
Copy link
Contributor

@JustinGOSSES are you able to come discuss this proposal with the WG on our 30July call?

@JustinGOSSES
Copy link
Author

@david-a-wheeler
Copy link
Contributor

There's no policy against cross-linking. As long as the link helps our readers (or gives attribution/credit for material), great!

@david-a-wheeler
Copy link
Contributor

I suggest text link “for additional guidance for inner sourcing, consider… : ”. Can you create a pull request?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants