Speckle Repo Management Templates

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,
• Default Contribution Guidelines,
• README template (you're reading it now),
• Default Issue Template,
• 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.

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.

Community

The Speckle Community hangs out in two main places, usually:

• on the forum
• on the chat

Do join and introduce yourself!

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.