diff --git a/README.md b/README.md index fa135ab3db..7504771c9e 100644 --- a/README.md +++ b/README.md @@ -1,57 +1,60 @@ -# Open Source Guides +# 🌐 Open Source Guides [![Build Status](https://github.com/github/opensource.guide/workflows/GitHub%20Actions%20CI/badge.svg)](https://github.com/github/opensource.guide/actions) -Open Source Guides (https://opensource.guide/) are a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open-source project. - -## Background -Open Source Guides were created and are curated by GitHub, along with input from outside community reviewers, but they are not exclusive to GitHub products. One reason we started this project is that we felt that there weren't enough resources for people creating open-source projects. - -Our goal was to aggregate community best practices, *not* what GitHub (or any other individual or entity) thinks is best. Therefore, we used examples and quotations from others to illustrate our points. - -## Contributing - -This site is powered by [Jekyll](https://jekyllrb.com/). Check out our [contributing guidelines](/CONTRIBUTING.md) for ways to offer feedback and contribute. - -## Licenses - -Content is released under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/). See [notices](notices.md) for complete details, including attribution guidelines, contribution terms, and software and third-party licenses and permissions. - -## Acknowledgments - -The initial release of these guides were authored by **[@nayafia][1], [@bkeepers][2], [@stephbwills][3],** and **[@mlinksva][4]**. - -Thanks to **[@aitchabee][5], [@benbalter][6], [@brettcannon][7], [@caabernathy][8], [@coralineada][9], [@dmleong][10], [@ericholscher][11], [@gr2m][12], [@janl][13], [@jessfraz][14], [@joshsimmons][15], [@kfogel][16], [@kytrinyx][17], [@lee-dohm][18], [@mikeal][19], [@mikemcquaid][20], [@nathansobo][21], [@nruff][22], [@nsqe][23], [@orta][24], [@parkr][25], [@shazow][26], [@steveklabnik][27],** and **[@wooorm][28]** for lending their valuable input and expertise leading up to the initial release, and to **[@sophshep][29]** and **[@jeejkang][30]** for designing and illustrating the guides. - -## Disclaimer -While we've got advice about running an open source project, we're not lawyers. Be sure to read our [disclaimer](notices.md#legal-disclaimer) before diving in. - -[1]:https://github.com/nayafia -[2]:https://github.com/bkeepers -[3]:https://github.com/stephbwills -[4]:https://github.com/mlinksva -[5]:https://github.com/aitchabee -[6]:https://github.com/benbalter -[7]:https://github.com/brettcannon -[8]:https://github.com/caabernathy -[9]:https://github.com/CoralineAda -[10]:https://github.com/dmleong -[11]:https://github.com/ericholscher -[12]:https://github.com/gr2m -[13]:https://github.com/janl -[14]:https://github.com/jessfraz -[15]:https://github.com/joshsimmons -[16]:https://github.com/kfogel -[17]:https://github.com/kytrinyx -[18]:https://github.com/lee-dohm -[19]:https://github.com/mikeal -[20]:https://github.com/MikeMcQuaid -[21]:https://github.com/nathansobo -[22]:https://github.com/nruff -[23]:https://github.com/nsqe -[24]:https://github.com/orta -[25]:https://github.com/parkr -[26]:https://github.com/shazow -[27]:https://github.com/steveklabnik -[28]:https://github.com/wooorm -[29]:https://github.com/sophshep -[30]:https://github.com/jeejkang +**[Open Source Guides](https://opensource.guide/)** provide a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to open-source projects. + +## πŸ“– Background +- **Created by GitHub** with input from community reviewers, these guides are not exclusive to GitHub products. +- **Purpose**: Address the shortage of resources for people creating open-source projects. +- **Goal**: Share community best practices β€” not just GitHub’s view β€” by using examples and quotes from the open-source community. + +## 🀝 Contributing +- **Powered by** [Jekyll](https://jekyllrb.com/). Check out our [contributing guidelines](/CONTRIBUTING.md) to learn how you can provide feedback and contribute. + +## πŸ“œ Licenses +- **Content License**: Released under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/). See [notices](notices.md) for full details, including: + - Attribution guidelines + - Contribution terms + - Software and third-party licenses and permissions + +## 🌟 Acknowledgments +Special thanks to the authors and contributors who made the initial release possible: + +- **Authors**: [@nayafia][1], [@bkeepers][2], [@stephbwills][3], and [@mlinksva][4] +- **Additional Contributors**: [@aitchabee][5], [@benbalter][6], [@brettcannon][7], [@caabernathy][8], [@coralineada][9], [@dmleong][10], [@ericholscher][11], [@gr2m][12], [@janl][13], [@jessfraz][14], [@joshsimmons][15], [@kfogel][16], [@kytrinyx][17], [@lee-dohm][18], [@mikeal][19], [@mikemcquaid][20], [@nathansobo][21], [@nruff][22], [@nsqe][23], [@orta][24], [@parkr][25], [@shazow][26], [@steveklabnik][27], and [@wooorm][28] +- **Design and Illustrations**: [@sophshep][29] and [@jeejkang][30] + +## ⚠️ Disclaimer +These guides provide general advice on running an open-source project. However, this is **not legal advice**. Please read our [disclaimer](notices.md#legal-disclaimer) for more information. + +[1]: https://github.com/nayafia +[2]: https://github.com/bkeepers +[3]: https://github.com/stephbwills +[4]: https://github.com/mlinksva +[5]: https://github.com/aitchabee +[6]: https://github.com/benbalter +[7]: https://github.com/brettcannon +[8]: https://github.com/caabernathy +[9]: https://github.com/CoralineAda +[10]: https://github.com/dmleong +[11]: https://github.com/ericholscher +[12]: https://github.com/gr2m +[13]: https://github.com/janl +[14]: https://github.com/jessfraz +[15]: https://github.com/joshsimmons +[16]: https://github.com/kfogel +[17]: https://github.com/kytrinyx +[18]: https://github.com/lee-dohm +[19]: https://github.com/mikeal +[20]: https://github.com/MikeMcQuaid +[21]: https://github.com/nathansobo +[22]: https://github.com/nruff +[23]: https://github.com/nsqe +[24]: https://github.com/orta +[25]: https://github.com/parkr +[26]: https://github.com/shazow +[27]: https://github.com/steveklabnik +[28]: https://github.com/wooorm +[29]: https://github.com/sophshep +[30]: https://github.com/jeejkang +