diff --git a/guides-and-standards/standards--public-repos.md b/guides-and-standards/standards--public-repos.md index fc1f800..acea307 100644 --- a/guides-and-standards/standards--public-repos.md +++ b/guides-and-standards/standards--public-repos.md @@ -24,6 +24,7 @@ We have Arcadia-specific templates for [Python](https://github.com/Arcadia-Scien - **No sensitive information**: The repository should not include any sensitive or private information like API keys or access credentials. See [the section below](#about-sensitive-information) for more information on this. - **License**: The repository should use the MIT license, if possible. Please refer to [this notion page](https://www.notion.so/arcadiascience/Coding-at-Arcadia-Software-Licensing-Policy-9054a0b178d74a42a7a4ad41de46a671?pvs=4) for more information. - Caveat: the MIT license is compatible with most, but not all, other open-source software licenses. If your project uses software with an incompatible license, you will need to use a different license. Please check with both the legal team and the software team if you are unsure about this. +- **CITATION.cff**: We encourage all **pub-related** repositories to include a CITATION.cff file in the repo which contains the citation for the pub. This will be automatically generated when the first byline sign-off request is sent. You will receive a Slack message with a link to download it from the [Current pubs](https://airtable.com/appN7KQ55bT6HHfog/pagC0lEtFxTO510BP?u3Ldt=allRecords) page on Airtable. - **Repository settings**: To protect the repository from unintended changes, branch protection rules should be configured for the `main` branch. Please refer to the [this notion page](https://www.notion.so/arcadiascience/How-to-manage-paired-public-and-private-GitHub-repos-2c3e96d6097943a099c3cdc0ab8789df) for details. ## About sensitive information