# CONTRIBUTING.md template ## GOALS / INSTRUCTIONS - If you have more details than the swift.org/contributing guide, copy and paste this template. Fill it out with the sections that make sense. - If you have the same details as swift.org/contributing, you'll add a section to your README and ignore this template. - Take the sections that apply and leave the ones that don't - Remove all brackets and questions posed at you as the author ---------- ## Welcome the Swift community! Contributions to Swift are welcomed and encouraged! Please see the Contributing to Swift guide and check out the structure of the community.[links] To be a truly great community, Swift needs to welcome developers from all walks of life, with different backgrounds, and with a wide range of experience. A diverse and friendly community will have more great ideas, more unique perspectives, and produce more great code. We will work diligently to make the Swift community welcoming to everyone. To give clarity of what is expected of our members, Swift has adopted the code of conduct defined by the Contributor Covenant. This document is used across many open source communities, and we think it articulates our values well. For more, see the Code of Conduct. [link] ## Contributing to /swiftlang/repo-name-here ### How you can help We would love your contributions in the form of: - this is your wishlist! - don't forget documentation, samples, conference talks - helping to triage the issue log - think of really concrete things that can help people get started - need future CODEOWNERs? great place to put some words down on how that is achievable here ### Submitting Issues and Pull Requests [ONLY if different than swift.org/contributing] #### Issues [insert instructions helping with triage - how?] [insert instructions about labels] [If your repo uses good first issues or help wanted, indicate that here with some basic definitions or link to the main contributing guide defintions] #### PR Style Guide or Format [is there a style to follow or other conventions?] #### Build and Test [Insert instructions here on how to build and test the repository] #### Running CI [instructions for process here] #### Other pre-check PR scripts [insert instructions for anything that happens / needs to happen on pre-check] ### Getting your PR reviewed [instructions on how to call to the attention of the reviewers] [how to find out who the reviewers are] [authoring commits] [squash ok?]