Helpful file templates and guidance for repositories in github.com/swiftlang. Project maintainers should use this guidance for the root files of every repository.
There is an organizational level .github folder that optimizes for consistency across all repositories. Read more information about GitHub Org Level Files here
- CONDUCT.md**
- SECURITY.md**
- CONTRIBUTING.md (links to swift.org/contributing)
** = special exception from the Core Team in order to opt-out
The following files are required in each repo and are not set at Org level:
- LICENSE
If it's not Apache 2.0 with runtime exception, the Core Team will need to approve. - README.md
Special Note:
- CONTRIBUTING.md
We encourage repo owners to have a custom CONTRIBUTING.md file. Many repos have different review flows, environment set up instructions, testing, and related that may help contributors AND maintainers have a better experience. - NOTICE or ACKNOWLEDGEMENTS
A repository may need to use one of these two files to include license information and more for dependencies, vendored code, etc. Please work with the Core Team to figure out the best course of action here.
.github templates:
- codeowners
- pull request template
- issue template
We welcome contributions to this repository! Please read the Contributor Guide to get started. If you'd like to propose a new file, section, or major change, please start with an issue or start a discussion post in the category for the Contributor Experience Workgroup on the Forums.