Initial commit

2022-08-25 09:55:27 +01:00
commit 6b6d19dce0
10 changed files with 808 additions and 0 deletions
@@ -0,0 +1,56 @@
+# Speckle Repo Management Templates
+
+[![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Community forum users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiscourse.speckle.works&style=flat-square&logo=discourse&logoColor=white)](https://discourse.speckle.works) [![website](https://img.shields.io/badge/https://-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) [![docs](https://img.shields.io/badge/docs-speckle.guide-orange?style=flat-square&logo=read-the-docs&logoColor=white)](https://speckle.guide/dev/)
+
+## Introduction
+
+This section should hold a quick intro on what this repo's about. For example:
+
+This repo holds Speckle's:
+
+- Default [Code of Conduct](.github/CODE_OF_CONDUCT.md),
+- Default [Contribution Guidelines](.github/CONTRIBUTING.md),
+- README template (you're reading it now),
+- Default [Issue Template](.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md),
+- Default [Pull Request Template](.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md),
+- OSS License (Apache 2.0)
+
+Either copy paste the parts that are useful in existing repos, or use this as a base when creating a new repository.
+
+## Documentation
+
+Comprehensive developer and user documentation can be found in our:
+
+#### 📚 [Speckle Docs website](https://speckle.guide/dev/)
+
+## This Readme Template
+
+Is rather straightforward. It includes several default sections and one section that requires special attention.
+
+Default sections:
+
+- Badges: has several default social badges. Feel free to add more.
+- Developing & Debugging - needs filling in!
+- Community - can be left as is.
+
+**License section**: If this is a pure OSS repo, like Core, remove everything after the first phrase. Otherwise, we need to plan ahead before releasing and make sure we're covered.
+
+## Developing & Debugging
+
+This doesn't make sense here, but in general, we should try to provide a small "how to" guide on local development and debugging, as it lowers the barrier to contributions.
+
+## Contributing
+
+Please make sure you read the [contribution guidelines](.github/CONTRIBUTING.md) and [code of conduct](.github/CODE_OF_CONDUCT.md) for an overview of the practices we try to follow.
+
+## Community
+
+The Speckle Community hangs out on [the forum](https://discourse.speckle.works), do join and introduce yourself & feel free to ask us questions!
+
+## Security
+
+For any security vulnerabilities or concerns, please contact us directly at security[at]speckle.systems.
+
+## License
+
+Unless otherwise described, the code in this repository is licensed under the Apache-2.0 License. Please note that some modules, extensions or code herein might be otherwise licensed. This is indicated either in the root of the containing folder under a different license file, or in the respective file's header. If you have any questions, don't hesitate to get in touch with us via [email](mailto:hello@speckle.systems).