Skip to content

Commit 79933c1

Browse files
authored
Merge pull request #712 from LLNL/updates
Updates to FAQ and Licenses based on recent user questions
2 parents 2e3e45c + 6e7aba5 commit 79933c1

2 files changed

Lines changed: 21 additions & 6 deletions

File tree

about/faq.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -199,21 +199,22 @@ Now that your project is on GitHub, make sure users and contributors can find it
199199
{% include components/accordion.html title='How do I let people know about my new repo?' slug='publicize' content=accordionContent %}
200200

201201
{% capture accordionContent %}
202-
Submit a pull request! This website is a GitHub repo just like any other LLNL open source project. News is housed in the [`_posts` directory](https://github.com/LLNL/llnl.github.io/tree/main/_posts), and templates are found in the [LLNL/.github repo](https://github.com/LLNL/.github). See [Contributing Guidelines](../contribute) for more information.
202+
Yes, you can give external contributors Write access to your GitHub repo. Anyone with Admin access to your repo can enable this: Settings > Collaborators > Manage access > Add people > enter their username and select.
203+
204+
If you don't already have Admin access to your repo, contact [github-admin@llnl.gov](mailto:github-admin@llnl.gov) to request it.
203205

204-
Before contributing, please contact [open-source@llnl.gov](mailto:open-source@llnl.gov) with your idea or if you have questions about whether your proposed content requires the LLNL review and release process.
205206
{% endcapture %}
206207
{% assign accordionContent = accordionContent | markdownify %}
207-
{% include components/accordion.html title='How do I contribute news or other content to this website?' slug='contribute-here' content=accordionContent %}
208+
{% include components/accordion.html title='Can non-LLNL developers/collaborators contribute to my project?' slug='collaborators' content=accordionContent %}
208209

209210
{% capture accordionContent %}
210-
Yes, you can give external contributors Write access to your GitHub repo. Anyone with Admin access to your repo can enable this: Settings > Collaborators > Manage access > Add people > enter their username and select.
211+
If the owner/admin of a repo leaves the project, another team member(s) with a GitHub account must take over the Admin role.
211212

212-
If you don't already have Admin access to your repo, contact [github-admin@llnl.gov](mailto:github-admin@llnl.gov) to request it.
213+
If you need help re-assigning permissions in your repo, contact [github-admin@llnl.gov](mailto:github-admin@llnl.gov) to confirm the user's departure and successor(s).
213214

214215
{% endcapture %}
215216
{% assign accordionContent = accordionContent | markdownify %}
216-
{% include components/accordion.html title='Can non-LLNL developers/collaborators contribute to my project?' slug='collaborators' content=accordionContent %}
217+
{% include components/accordion.html title='How do I change ownership of a specific repo?' slug='new-owner' content=accordionContent %}
217218

218219
{% capture accordionContent %}
219220

@@ -277,5 +278,13 @@ Refer to individual projects for their requirements on accepting contributions.
277278
{% assign accordionContent = accordionContent | markdownify %}
278279
{% include components/accordion.html title='How do I contribute to an LLNL repo?' slug='contribute-repo' content=accordionContent %}
279280

281+
{% capture accordionContent %}
282+
Submit a pull request! This website is a GitHub repo just like any other LLNL open source project. News is housed in the [`_posts` directory](https://github.com/LLNL/llnl.github.io/tree/main/_posts), and templates are found in the [LLNL/.github repo](https://github.com/LLNL/.github). See [Contributing Guidelines](../contribute) for more information.
283+
284+
Before contributing, please contact [open-source@llnl.gov](mailto:open-source@llnl.gov) with your idea or if you have questions about whether your proposed content requires the LLNL review and release process.
285+
{% endcapture %}
286+
{% assign accordionContent = accordionContent | markdownify %}
287+
{% include components/accordion.html title='How do I contribute news or other content to this website?' slug='contribute-here' content=accordionContent %}
288+
280289
</div>
281290
<!-- END: Accordions -->

about/licenses/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,12 @@ The Spack example mentions a [`COPYRIGHT`](https://github.com/spack/spack/blob/d
158158

159159
For more information on using SPDX in your code, see the [SPDX website](https://spdx.org/licenses/).
160160

161+
### Source file license headers
162+
163+
Header requirements can vary depending on the chosen license. Most open source licenses (e.g., Apache 2.0, MIT, GPL) do not strictly require license headers in each file, while others (e.g., LGPL-3.0) do. In any case, brief headers are recommended to ensure that whichever license you choose is also included with the source code, especially if those files are re-used.
164+
165+
For example, visit the [Spack](https://github.com/spack/spack) or [Flux](https://github.com/flux-framework) projects to see how the different source files are labeled with headers depending on the license.
166+
161167
### Developer Certificate of Origin (DCO)
162168

163169
As mentioned above, the default assumption for open source projects is ["inbound license = outbound license"](https://opensource.guide/legal/), i.e., contributors provide their code under the same license under which the code is distributed. If this is not enough assurance for your project, you may use the [Developer Certificate of Origin (DCO)](https://developercertificate.org/) with your project.

0 commit comments

Comments
 (0)