From 105ae0316c4312f95a1854c676812e9d74dd3adc Mon Sep 17 00:00:00 2001 From: Dimitrie Stefanescu Date: Thu, 20 Aug 2020 17:11:10 +0300 Subject: [PATCH 01/41] Initial commit --- README.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..86e4242 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +# repository-template \ No newline at end of file From 040a49baeafc5202d03f6be74b475abe7d9e7dcb Mon Sep 17 00:00:00 2001 From: Dimitrie Stefanescu Date: Thu, 20 Aug 2020 17:15:20 +0300 Subject: [PATCH 02/41] Create CODE_OF_CONDUCT.md --- CODE_OF_CONDUCT.md | 76 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..af11c1a --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,76 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at hello@speckle.systems. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq From fb797e64cb19a3bf661a47c57f345cf0f9b0579f Mon Sep 17 00:00:00 2001 From: Dimitrie Stefanescu Date: Thu, 20 Aug 2020 17:25:04 +0300 Subject: [PATCH 03/41] Create CONTRIBUTING.MD --- CONTRIBUTING.MD | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 CONTRIBUTING.MD diff --git a/CONTRIBUTING.MD b/CONTRIBUTING.MD new file mode 100644 index 0000000..b96a211 --- /dev/null +++ b/CONTRIBUTING.MD @@ -0,0 +1,46 @@ +# Speckle Contribution Guidelines +## Introduction + +Thank you for reading this! Speckle's a rather wide network of parts that depend on each other, either directly, indirectly or even just cosmetically. + +> **Speckle** is a quite large ecosystem of moving parts. Any changes may have unintended effects, that can cause problems quickly for many people (and processes) that rely on Speckle. + +This means that what might look like a simple quick change in one repo may have a big hidden cost that propagates around other parts of the project. We're all here to help each other, and this guide is meant to help you get started and promote a framework that can untangle all these dependecies through discussion! + +## Bugs & Issues 🐞 + +### Found a new bug? + +- First step is to check whether this is a new bug! We encourage you to search through the issues of the project in question **and** associated repos! + +- If you come up with nothing, **open a new issue with a clear title and description**, as much relevant information as possible: system configuration, code samples & steps to reproduce the problem. + +- Try to reference & note all potentially affected projects. + +### Sending a PR for Bug Fixes + +You fixed something! Great! We hope you logged it first :) Make sure though that you've covered the lateral thinking needed for a bug report, as described above, also in your implementation! If there any tests, make sure they all pass. If there are none, it means they're missing - so add them! + +## New Features 🎉 + +The golden rule is to Discuss First! + +- Before embarking on adding a new feature, suggest it first as an issue with the `enhancement` label and/or title - this will allow relevant people to pitch in +- We'll now discuss your requirements and see how and if they fit within the Speckle ecosystem. +- The last step is to actually start writing code & submit a PR so we can follow along! + +> Many clients may potentially have overlapping scopes, some features might already be in dev somewhere else, or might have been postponed to the next major release due to api instability in that area. For example, adding a delete stream button in the accounts panel in rhino: this feature was planned for speckle admin, and the whole functionality of the accounts panel in rhino is to be greatly reduced! + +## Cosmetic Patches ✨ + +Changes that are cosmetic in nature and do not add anything substantial to the stability or functionality of Speckle **will generally not be accepted**. + +Why? However trivial the changes might seem, there might be subtle reasons for the original code to be as it is. Furthermore, there are a lot of potential hidden costs (that even maintainers themselves are not aware of fully!) and they eat up review time unncessarily. + +> **Examples**: modifying the colour of an UI element in one client may have a big hidden cost and need propagation in several other clients that implement a similar ui element. Changing the default port or specifiying `localhost` instead of `0.0.0.0` breaks cross-vm debugging and developing. + + +## Wrap up +Don't worry if you get things wrong. We all do, including project owners: this document should've been here a long time ago. There's plenty of room for discussion either on our [chat channels](https://slacker.speckle.works) or [the forum](https://discourse.speckle.works). + +🙌❤️💙💚💜🙌 From b87237b88ff579b8c589b844af0d44f7cf0df002 Mon Sep 17 00:00:00 2001 From: Dimitrie Stefanescu Date: Thu, 20 Aug 2020 17:28:11 +0300 Subject: [PATCH 04/41] Update CODE_OF_CONDUCT.md adds authoritative source notice to this repo --- CODE_OF_CONDUCT.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index af11c1a..c1f3afe 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -74,3 +74,5 @@ available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.ht For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq + +> This document version might be superseeded. The authorative source is [here](https://github.com/Speckle-Next/repository-template/blob/master/CODE_OF_CONDUCT.md). From 7e57b4cfb6dba0d78faf1af47994a9b626aee961 Mon Sep 17 00:00:00 2001 From: Dimitrie Stefanescu Date: Thu, 20 Aug 2020 17:40:39 +0300 Subject: [PATCH 05/41] Create ISSUE_TEMPLATE.md --- ISSUE_TEMPLATE.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 ISSUE_TEMPLATE.md diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..241ff64 --- /dev/null +++ b/ISSUE_TEMPLATE.md @@ -0,0 +1,17 @@ +If it's your first time here - or you forgot about them - make sure you read the [contribution guidelines](https://github.com/speckleworks/SpeckleOrg/blob/master/CONTRIBUTING.md), and then feel free to delete this line! + +### Expected vs. Actual Behaviour + +Describe the problem here. + +### Reproduction Steps & System Config (win, osx, web, etc.) + +Let us know how we can reproduce this. We will ignore issues without clear reproduction steps. + +### Proposed Solution (if any) + +Let us know what how you would solve this. + +#### Otional: Affected Projects + +Does this issue propagate to other dependencies or dependants? If so, list them here! From c1dfe5f11f51620b81b9adccd17f2f5f9403889e Mon Sep 17 00:00:00 2001 From: Dimitrie Stefanescu Date: Thu, 20 Aug 2020 17:41:43 +0300 Subject: [PATCH 06/41] Update CODE_OF_CONDUCT.md --- CODE_OF_CONDUCT.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index c1f3afe..0e7c00c 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -75,4 +75,4 @@ available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.ht For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq -> This document version might be superseeded. The authorative source is [here](https://github.com/Speckle-Next/repository-template/blob/master/CODE_OF_CONDUCT.md). +> This document version might be superseeded. The authorative source is [here](https://github.com/Speckle-Next/repo-management-basics/blob/master/CODE_OF_CONDUCT.md). From 42cda6a477f564b56b3ea1eeeed1c92792de3729 Mon Sep 17 00:00:00 2001 From: Dimitrie Stefanescu Date: Thu, 20 Aug 2020 17:44:23 +0300 Subject: [PATCH 07/41] Update and rename CONTRIBUTING.MD to CONTRIBUTING.md --- CONTRIBUTING.MD => CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) rename CONTRIBUTING.MD => CONTRIBUTING.md (89%) diff --git a/CONTRIBUTING.MD b/CONTRIBUTING.md similarity index 89% rename from CONTRIBUTING.MD rename to CONTRIBUTING.md index b96a211..80a7da0 100644 --- a/CONTRIBUTING.MD +++ b/CONTRIBUTING.md @@ -15,6 +15,8 @@ This means that what might look like a simple quick change in one repo may have - If you come up with nothing, **open a new issue with a clear title and description**, as much relevant information as possible: system configuration, code samples & steps to reproduce the problem. +- Can't mention this often enough: tells us how to reproduce the problem! We will ignore or flag as such issues without reproduction steps. + - Try to reference & note all potentially affected projects. ### Sending a PR for Bug Fixes @@ -28,6 +30,7 @@ The golden rule is to Discuss First! - Before embarking on adding a new feature, suggest it first as an issue with the `enhancement` label and/or title - this will allow relevant people to pitch in - We'll now discuss your requirements and see how and if they fit within the Speckle ecosystem. - The last step is to actually start writing code & submit a PR so we can follow along! +- All new features should, if and where possible, come with tests. We won't merge without! > Many clients may potentially have overlapping scopes, some features might already be in dev somewhere else, or might have been postponed to the next major release due to api instability in that area. For example, adding a delete stream button in the accounts panel in rhino: this feature was planned for speckle admin, and the whole functionality of the accounts panel in rhino is to be greatly reduced! @@ -44,3 +47,5 @@ Why? However trivial the changes might seem, there might be subtle reasons for t Don't worry if you get things wrong. We all do, including project owners: this document should've been here a long time ago. There's plenty of room for discussion either on our [chat channels](https://slacker.speckle.works) or [the forum](https://discourse.speckle.works). 🙌❤️💙💚💜🙌 + +> This document version might be superseeded. The authorative source is [here](https://github.com/Speckle-Next/repo-management-basics/edit/master/CONTRIBUTING.md). From acb7156bf2799937b742bb8179b7337010c73171 Mon Sep 17 00:00:00 2001 From: Dimitrie Stefanescu Date: Thu, 20 Aug 2020 17:56:41 +0300 Subject: [PATCH 08/41] Update README.md adds basic default social badges - discourse and twitter --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 86e4242..007d5af 100644 --- a/README.md +++ b/README.md @@ -1 +1,8 @@ -# repository-template \ No newline at end of file +# Project name +--- + +[![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Discourse users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiscourse.speckle.works&style=flat-square)](https://discourse.speckle.works) + +--- + +Short and sweet description; whatever other necessary info. From d3d53ef6a54f8cb34333f48d1cd11ade5a2c3ab2 Mon Sep 17 00:00:00 2001 From: Dimitrie Stefanescu Date: Thu, 20 Aug 2020 18:01:04 +0300 Subject: [PATCH 09/41] Update README.md --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 007d5af..52113b0 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,7 @@ -# Project name ---- +# Project Name [![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Discourse users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiscourse.speckle.works&style=flat-square)](https://discourse.speckle.works) - +[![website](https://img.shields.io/badge/www-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) --- Short and sweet description; whatever other necessary info. From e42a3d41470c784ecd33dabd4948dd27d08fddd7 Mon Sep 17 00:00:00 2001 From: Dimitrie Stefanescu Date: Thu, 20 Aug 2020 18:04:36 +0300 Subject: [PATCH 10/41] Update README.md --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 52113b0..39721db 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,13 @@ -# Project Name +# Speckle Repo Management Templates [![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Discourse users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiscourse.speckle.works&style=flat-square)](https://discourse.speckle.works) [![website](https://img.shields.io/badge/www-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) --- -Short and sweet description; whatever other necessary info. +This repo holds Speckle's: +- base COC, +- Contribution Guidelines, +- README template (this one!), +- and Issue Template. + +Either copy paste the parts that are useful in existing repos, or use this as a base when creating a new repository. From 1f57e81ddc286444274071c1a11834fe1ad1c66e Mon Sep 17 00:00:00 2001 From: Dimitrie Stefanescu Date: Thu, 20 Aug 2020 18:16:14 +0300 Subject: [PATCH 11/41] Update README.md --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 39721db..0d5f456 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,10 @@ [![website](https://img.shields.io/badge/www-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) --- +## Introduction + +This section should hold a quick intro on what this repo's about. For example: + This repo holds Speckle's: - base COC, - Contribution Guidelines, @@ -11,3 +15,15 @@ This repo holds Speckle's: - and Issue Template. Either copy paste the parts that are useful in existing repos, or use this as a base when creating a new repository. + +## 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](https://discourse.speckle.works) +- on [the chat](https://discordapp.com/channels/726756379083145269/726756380199092258/746023170519203990) + +Do join and introduce yourself! From 4a924593b3f16baf8a8fb287cd4fa6bb464a0318 Mon Sep 17 00:00:00 2001 From: Dimitrie Stefanescu Date: Thu, 20 Aug 2020 18:16:52 +0300 Subject: [PATCH 12/41] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0d5f456..23e1b85 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Discourse users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiscourse.speckle.works&style=flat-square)](https://discourse.speckle.works) [![website](https://img.shields.io/badge/www-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) ---- + ## Introduction From e69310619ee6a3b3bcb186df414742e6070fa422 Mon Sep 17 00:00:00 2001 From: Dimitrie Stefanescu Date: Thu, 20 Aug 2020 18:21:43 +0300 Subject: [PATCH 13/41] Create LICENSE --- LICENSE | 201 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 201 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f83b45e --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2020 AEC Systems + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. From f7b867c2195158b268bf8ac54ca7ab93141dd653 Mon Sep 17 00:00:00 2001 From: Dimitrie Stefanescu Date: Thu, 20 Aug 2020 18:37:15 +0300 Subject: [PATCH 14/41] Update README.md --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 23e1b85..b4c887e 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,22 @@ This repo holds Speckle's: - base COC, - Contribution Guidelines, - README template (this one!), -- and Issue Template. +- Issue Template, +- OSS License (Apache 2.0) & notice. 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. @@ -27,3 +39,6 @@ The Speckle Community hangs out in two main places, usually: - on [the chat](https://discordapp.com/channels/726756379083145269/726756380199092258/746023170519203990) 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](mailto:hello@speckle.systems). From ec8635401b9c12428855f062e16b26bab59cde18 Mon Sep 17 00:00:00 2001 From: Dimitrie Stefanescu Date: Thu, 20 Aug 2020 18:44:18 +0300 Subject: [PATCH 15/41] Update README.md --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b4c887e..46897f3 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,11 @@ This section should hold a quick intro on what this repo's about. For example: This repo holds Speckle's: -- base COC, -- Contribution Guidelines, -- README template (this one!), -- Issue Template, -- OSS License (Apache 2.0) & notice. +- Default [Code of Conduct](https://github.com/Speckle-Next/repo-management-basics/blob/master/CODE_OF_CONDUCT.md), +- Default [Contribution Guidelines](https://github.com/Speckle-Next/repo-management-basics/blob/master/CONTRIBUTING.md), +- README template (you're reading it now), +- Default [Issue Template](https://github.com/Speckle-Next/repo-management-basics/blob/master/ISSUE_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. @@ -41,4 +41,4 @@ The Speckle Community hangs out in two main places, usually: 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](mailto:hello@speckle.systems). +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). From 9e110a125bf5930c74064ba3a39da4be1f519852 Mon Sep 17 00:00:00 2001 From: Dimitrie Stefanescu Date: Thu, 20 Aug 2020 18:45:35 +0300 Subject: [PATCH 16/41] Update CONTRIBUTING.md fixes link --- CONTRIBUTING.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 80a7da0..3ee7964 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -47,5 +47,3 @@ Why? However trivial the changes might seem, there might be subtle reasons for t Don't worry if you get things wrong. We all do, including project owners: this document should've been here a long time ago. There's plenty of room for discussion either on our [chat channels](https://slacker.speckle.works) or [the forum](https://discourse.speckle.works). 🙌❤️💙💚💜🙌 - -> This document version might be superseeded. The authorative source is [here](https://github.com/Speckle-Next/repo-management-basics/edit/master/CONTRIBUTING.md). From 8e986e59aaf389f30410051f2b02ba500173d885 Mon Sep 17 00:00:00 2001 From: Dimitrie Stefanescu Date: Thu, 20 Aug 2020 18:45:50 +0300 Subject: [PATCH 17/41] Update CODE_OF_CONDUCT.md --- CODE_OF_CONDUCT.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 0e7c00c..af11c1a 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -74,5 +74,3 @@ available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.ht For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq - -> This document version might be superseeded. The authorative source is [here](https://github.com/Speckle-Next/repo-management-basics/blob/master/CODE_OF_CONDUCT.md). From bcecaef38094430fdc21870409075e7a0ad53fc6 Mon Sep 17 00:00:00 2001 From: izzy lyseggen Date: Thu, 20 Aug 2020 17:11:53 +0100 Subject: [PATCH 18/41] docs: add slack link and badge --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 46897f3..784d667 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Speckle Repo Management Templates [![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Discourse users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiscourse.speckle.works&style=flat-square)](https://discourse.speckle.works) -[![website](https://img.shields.io/badge/www-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) +[![Slack Invite](https://img.shields.io/badge/-slack-grey?style=flat-square&logo=slack)](https://speckle-works.slack.com/join/shared_invite/enQtNjY5Mzk2NTYxNTA4LTU4MWI5ZjdhMjFmMTIxZDIzOTAzMzRmMTZhY2QxMmM1ZjVmNzJmZGMzMDVlZmJjYWQxYWU0MWJkYmY3N2JjNGI) [![website](https://img.shields.io/badge/www-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) ## Introduction @@ -36,7 +36,7 @@ This doesn't make sense here, but in general, we should try to provide a small " The Speckle Community hangs out in two main places, usually: - on [the forum](https://discourse.speckle.works) -- on [the chat](https://discordapp.com/channels/726756379083145269/726756380199092258/746023170519203990) +- on [the chat](https://speckle-works.slack.com/join/shared_invite/enQtNjY5Mzk2NTYxNTA4LTU4MWI5ZjdhMjFmMTIxZDIzOTAzMzRmMTZhY2QxMmM1ZjVmNzJmZGMzMDVlZmJjYWQxYWU0MWJkYmY3N2JjNGI) Do join and introduce yourself! From ecd9089e29940d30fb53b513c582f8903835e611 Mon Sep 17 00:00:00 2001 From: Dimitrie Stefanescu Date: Fri, 21 Aug 2020 19:08:32 +0300 Subject: [PATCH 19/41] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 784d667..59cecda 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,10 @@ Default sections: 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](https://github.com/Speckle-Next/repo-management-basics/blob/master/CONTRIBUTING.md) for an overview of the best practices we try to follow. + ## Community The Speckle Community hangs out in two main places, usually: From 2a30278e040f37dca47613ec26815f4f2898f402 Mon Sep 17 00:00:00 2001 From: Matteo Cominetti Date: Fri, 21 Aug 2020 17:52:00 +0100 Subject: [PATCH 20/41] fix: link and typos --- CONTRIBUTING.md | 2 +- ISSUE_TEMPLATE.md | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3ee7964..c6a1674 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,6 +44,6 @@ Why? However trivial the changes might seem, there might be subtle reasons for t ## Wrap up -Don't worry if you get things wrong. We all do, including project owners: this document should've been here a long time ago. There's plenty of room for discussion either on our [chat channels](https://slacker.speckle.works) or [the forum](https://discourse.speckle.works). +Don't worry if you get things wrong. We all do, including project owners: this document should've been here a long time ago. There's plenty of room for discussion either on our community [forum](https://discourse.speckle.works) or [chat](https://speckle-works.slack.com/join/shared_invite/enQtNjY5Mzk2NTYxNTA4LTU4MWI5ZjdhMjFmMTIxZDIzOTAzMzRmMTZhY2QxMmM1ZjVmNzJmZGMzMDVlZmJjYWQxYWU0MWJkYmY3N2JjNGI). 🙌❤️💙💚💜🙌 diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 241ff64..715765d 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1,17 +1,17 @@ -If it's your first time here - or you forgot about them - make sure you read the [contribution guidelines](https://github.com/speckleworks/SpeckleOrg/blob/master/CONTRIBUTING.md), and then feel free to delete this line! +If it's your first time here - or you forgot about them - make sure you read the [contribution guidelines](CONTRIBUTING.md), and then feel free to delete this line! -### Expected vs. Actual Behaviour +### Expected vs. Actual Behavior Describe the problem here. ### Reproduction Steps & System Config (win, osx, web, etc.) -Let us know how we can reproduce this. We will ignore issues without clear reproduction steps. +Let us know how we can reproduce this, and attach relevant files (if any). ### Proposed Solution (if any) Let us know what how you would solve this. -#### Otional: Affected Projects +#### Optional: Affected Projects -Does this issue propagate to other dependencies or dependants? If so, list them here! +Does this issue propagate to other dependencies or dependents? If so, list them here! From 7ddd8273409212b62ec370654d8ff23978794766 Mon Sep 17 00:00:00 2001 From: Matteo Cominetti Date: Fri, 21 Aug 2020 17:56:51 +0100 Subject: [PATCH 21/41] fix: more links --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 59cecda..27efc6a 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,10 @@ This section should hold a quick intro on what this repo's about. For example: This repo holds Speckle's: -- Default [Code of Conduct](https://github.com/Speckle-Next/repo-management-basics/blob/master/CODE_OF_CONDUCT.md), -- Default [Contribution Guidelines](https://github.com/Speckle-Next/repo-management-basics/blob/master/CONTRIBUTING.md), +- Default [Code of Conduct](CODE_OF_CONDUCT.md), +- Default [Contribution Guidelines](CONTRIBUTING.md), - README template (you're reading it now), -- Default [Issue Template](https://github.com/Speckle-Next/repo-management-basics/blob/master/ISSUE_TEMPLATE.md), +- Default [Issue Template](ISSUE_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. @@ -34,7 +34,7 @@ This doesn't make sense here, but in general, we should try to provide a small " ## Contributing -Please make sure you read the [contribution guidelines](https://github.com/Speckle-Next/repo-management-basics/blob/master/CONTRIBUTING.md) for an overview of the best practices we try to follow. +Please make sure you read the [contribution guidelines](CONTRIBUTING.md) for an overview of the best practices we try to follow. ## Community From d6b06298edc9aa310d8679ad2487541798c72370 Mon Sep 17 00:00:00 2001 From: Alan Rynne Date: Mon, 5 Oct 2020 16:56:52 +0200 Subject: [PATCH 22/41] refactor: moved files to .github/ folder --- .../CODE_OF_CONDUCT.md | 26 ++++++------- CONTRIBUTING.md => .github/CONTRIBUTING.md | 0 .../ISSUE_TEMPLATE/ISSUE_TEMPLATE.md | 8 ++-- README.md | 37 ++++++++++--------- 4 files changed, 37 insertions(+), 34 deletions(-) rename CODE_OF_CONDUCT.md => .github/CODE_OF_CONDUCT.md (82%) rename CONTRIBUTING.md => .github/CONTRIBUTING.md (100%) rename ISSUE_TEMPLATE.md => .github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md (78%) diff --git a/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md similarity index 82% rename from CODE_OF_CONDUCT.md rename to .github/CODE_OF_CONDUCT.md index af11c1a..e8e6e22 100644 --- a/CODE_OF_CONDUCT.md +++ b/.github/CODE_OF_CONDUCT.md @@ -14,22 +14,22 @@ appearance, race, religion, or sexual identity and orientation. Examples of behavior that contributes to creating a positive environment include: -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members Examples of unacceptable behavior by participants include: -* The use of sexualized language or imagery and unwelcome sexual attention or - advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting +- The use of sexualized language or imagery and unwelcome sexual attention or + advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic + address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting ## Our Responsibilities diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md diff --git a/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md similarity index 78% rename from ISSUE_TEMPLATE.md rename to .github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md index 715765d..9dcb418 100644 --- a/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md @@ -1,16 +1,16 @@ -If it's your first time here - or you forgot about them - make sure you read the [contribution guidelines](CONTRIBUTING.md), and then feel free to delete this line! +If it's your first time here - or you forgot about them - make sure you read the [contribution guidelines](CONTRIBUTING.md), and then feel free to delete this line! ### Expected vs. Actual Behavior -Describe the problem here. +Describe the problem here. ### Reproduction Steps & System Config (win, osx, web, etc.) -Let us know how we can reproduce this, and attach relevant files (if any). +Let us know how we can reproduce this, and attach relevant files (if any). ### Proposed Solution (if any) -Let us know what how you would solve this. +Let us know what how you would solve this. #### Optional: Affected Projects diff --git a/README.md b/README.md index 27efc6a..5c8e676 100644 --- a/README.md +++ b/README.md @@ -3,46 +3,49 @@ [![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Discourse users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiscourse.speckle.works&style=flat-square)](https://discourse.speckle.works) [![Slack Invite](https://img.shields.io/badge/-slack-grey?style=flat-square&logo=slack)](https://speckle-works.slack.com/join/shared_invite/enQtNjY5Mzk2NTYxNTA4LTU4MWI5ZjdhMjFmMTIxZDIzOTAzMzRmMTZhY2QxMmM1ZjVmNzJmZGMzMDVlZmJjYWQxYWU0MWJkYmY3N2JjNGI) [![website](https://img.shields.io/badge/www-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) - ## Introduction -This section should hold a quick intro on what this repo's about. For example: +This section should hold a quick intro on what this repo's about. For example: -This repo holds Speckle's: -- Default [Code of Conduct](CODE_OF_CONDUCT.md), -- Default [Contribution Guidelines](CONTRIBUTING.md), +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](ISSUE_TEMPLATE.md), +- Default [Issue Template](.github/ISSUE_TEMPLATE/ISSUE_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. +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. +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. +Default sections: + +- Badges: has several default social badges. Feel free to add more. - Developing & Debugging - needs filling in! -- Community - can be left as is. +- 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. +**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. +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](CONTRIBUTING.md) for an overview of the best practices we try to follow. -## Community +## Community + +The Speckle Community hangs out in two main places, usually: -The Speckle Community hangs out in two main places, usually: - on [the forum](https://discourse.speckle.works) -- on [the chat](https://speckle-works.slack.com/join/shared_invite/enQtNjY5Mzk2NTYxNTA4LTU4MWI5ZjdhMjFmMTIxZDIzOTAzMzRmMTZhY2QxMmM1ZjVmNzJmZGMzMDVlZmJjYWQxYWU0MWJkYmY3N2JjNGI) +- on [the chat](https://speckle-works.slack.com/join/shared_invite/enQtNjY5Mzk2NTYxNTA4LTU4MWI5ZjdhMjFmMTIxZDIzOTAzMzRmMTZhY2QxMmM1ZjVmNzJmZGMzMDVlZmJjYWQxYWU0MWJkYmY3N2JjNGI) -Do join and introduce yourself! +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](mailto:hello@speckle.systems). From e2daad36e99ddc7ac257385294d0491d0de2f660 Mon Sep 17 00:00:00 2001 From: Alan Rynne Date: Mon, 5 Oct 2020 16:58:20 +0200 Subject: [PATCH 23/41] feat: added PR template Updated docs to reflect it. --- .github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md | 25 ++++++++++++++++++++ README.md | 1 + 2 files changed, 26 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md new file mode 100644 index 0000000..c1701e0 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md @@ -0,0 +1,25 @@ +Description of PR... + +## Changes + +- Item 1 +- Item 2 + +## Checklist + +- [ ] Unit tests +- [ ] Documentation + +## References + +(optional) + +Include **important** links regarding the implementation of this PR. +This usually includes and RFC or an aggregation of issues and/or individual conversations +that helped put this solution together. This helps ensure there is a good aggregation +of resources regarding the implementation. + +```text +Fixes #85, Fixes #22, Fixes username/repo#123 +Connects #123 +``` diff --git a/README.md b/README.md index 5c8e676..b1b434b 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ This repo holds Speckle's: - 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. From 69cb2c79c7e8ec03c951472528607323c3d2d690 Mon Sep 17 00:00:00 2001 From: Alan Rynne Date: Mon, 5 Oct 2020 17:01:14 +0200 Subject: [PATCH 24/41] fix: updated old link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b1b434b..fae2457 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ This doesn't make sense here, but in general, we should try to provide a small " ## Contributing -Please make sure you read the [contribution guidelines](CONTRIBUTING.md) for an overview of the best practices we try to follow. +Please make sure you read the [contribution guidelines](.github/CONTRIBUTING.md) for an overview of the best practices we try to follow. ## Community From 162f99910007db6f27613cea5fb421201d22a6ca Mon Sep 17 00:00:00 2001 From: Alan Rynne Date: Mon, 5 Oct 2020 17:48:16 +0200 Subject: [PATCH 25/41] fix: added yaml frontmatter block to issue template --- .github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md index 9dcb418..26c8898 100644 --- a/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md @@ -1,3 +1,11 @@ +--- +name: New issue +about: Create a report to help us improve +title: +labels: +assignees: +--- + If it's your first time here - or you forgot about them - make sure you read the [contribution guidelines](CONTRIBUTING.md), and then feel free to delete this line! ### Expected vs. Actual Behavior From 8d3e511d187863e1343e7a04873339304b234fc8 Mon Sep 17 00:00:00 2001 From: Matteo Cominetti Date: Wed, 6 Jan 2021 16:45:48 +0000 Subject: [PATCH 26/41] docs: removes links to slack --- .github/CONTRIBUTING.md | 23 ++++++++++++----------- README.md | 10 ++-------- 2 files changed, 14 insertions(+), 19 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c6a1674..b7fa3e3 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,4 +1,5 @@ # Speckle Contribution Guidelines + ## Introduction Thank you for reading this! Speckle's a rather wide network of parts that depend on each other, either directly, indirectly or even just cosmetically. @@ -9,41 +10,41 @@ This means that what might look like a simple quick change in one repo may have ## Bugs & Issues 🐞 -### Found a new bug? +### Found a new bug? - First step is to check whether this is a new bug! We encourage you to search through the issues of the project in question **and** associated repos! -- If you come up with nothing, **open a new issue with a clear title and description**, as much relevant information as possible: system configuration, code samples & steps to reproduce the problem. +- If you come up with nothing, **open a new issue with a clear title and description**, as much relevant information as possible: system configuration, code samples & steps to reproduce the problem. -- Can't mention this often enough: tells us how to reproduce the problem! We will ignore or flag as such issues without reproduction steps. +- Can't mention this often enough: tells us how to reproduce the problem! We will ignore or flag as such issues without reproduction steps. - Try to reference & note all potentially affected projects. ### Sending a PR for Bug Fixes -You fixed something! Great! We hope you logged it first :) Make sure though that you've covered the lateral thinking needed for a bug report, as described above, also in your implementation! If there any tests, make sure they all pass. If there are none, it means they're missing - so add them! +You fixed something! Great! We hope you logged it first :) Make sure though that you've covered the lateral thinking needed for a bug report, as described above, also in your implementation! If there any tests, make sure they all pass. If there are none, it means they're missing - so add them! ## New Features 🎉 The golden rule is to Discuss First! - Before embarking on adding a new feature, suggest it first as an issue with the `enhancement` label and/or title - this will allow relevant people to pitch in -- We'll now discuss your requirements and see how and if they fit within the Speckle ecosystem. -- The last step is to actually start writing code & submit a PR so we can follow along! -- All new features should, if and where possible, come with tests. We won't merge without! +- We'll now discuss your requirements and see how and if they fit within the Speckle ecosystem. +- The last step is to actually start writing code & submit a PR so we can follow along! +- All new features should, if and where possible, come with tests. We won't merge without! > Many clients may potentially have overlapping scopes, some features might already be in dev somewhere else, or might have been postponed to the next major release due to api instability in that area. For example, adding a delete stream button in the accounts panel in rhino: this feature was planned for speckle admin, and the whole functionality of the accounts panel in rhino is to be greatly reduced! ## Cosmetic Patches ✨ -Changes that are cosmetic in nature and do not add anything substantial to the stability or functionality of Speckle **will generally not be accepted**. +Changes that are cosmetic in nature and do not add anything substantial to the stability or functionality of Speckle **will generally not be accepted**. Why? However trivial the changes might seem, there might be subtle reasons for the original code to be as it is. Furthermore, there are a lot of potential hidden costs (that even maintainers themselves are not aware of fully!) and they eat up review time unncessarily. -> **Examples**: modifying the colour of an UI element in one client may have a big hidden cost and need propagation in several other clients that implement a similar ui element. Changing the default port or specifiying `localhost` instead of `0.0.0.0` breaks cross-vm debugging and developing. - +> **Examples**: modifying the colour of an UI element in one client may have a big hidden cost and need propagation in several other clients that implement a similar ui element. Changing the default port or specifiying `localhost` instead of `0.0.0.0` breaks cross-vm debugging and developing. ## Wrap up -Don't worry if you get things wrong. We all do, including project owners: this document should've been here a long time ago. There's plenty of room for discussion either on our community [forum](https://discourse.speckle.works) or [chat](https://speckle-works.slack.com/join/shared_invite/enQtNjY5Mzk2NTYxNTA4LTU4MWI5ZjdhMjFmMTIxZDIzOTAzMzRmMTZhY2QxMmM1ZjVmNzJmZGMzMDVlZmJjYWQxYWU0MWJkYmY3N2JjNGI). + +Don't worry if you get things wrong. We all do, including project owners: this document should've been here a long time ago. There's plenty of room for discussion on our community [forum](https://discourse.speckle.works). 🙌❤️💙💚💜🙌 diff --git a/README.md b/README.md index fae2457..e3fcfec 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # Speckle Repo Management Templates -[![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Discourse users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiscourse.speckle.works&style=flat-square)](https://discourse.speckle.works) -[![Slack Invite](https://img.shields.io/badge/-slack-grey?style=flat-square&logo=slack)](https://speckle-works.slack.com/join/shared_invite/enQtNjY5Mzk2NTYxNTA4LTU4MWI5ZjdhMjFmMTIxZDIzOTAzMzRmMTZhY2QxMmM1ZjVmNzJmZGMzMDVlZmJjYWQxYWU0MWJkYmY3N2JjNGI) [![website](https://img.shields.io/badge/www-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) +[![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Discourse users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiscourse.speckle.works&style=flat-square)](https://discourse.speckle.works) [![website](https://img.shields.io/badge/www-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) ## Introduction @@ -40,12 +39,7 @@ Please make sure you read the [contribution guidelines](.github/CONTRIBUTING.md) ## Community -The Speckle Community hangs out in two main places, usually: - -- on [the forum](https://discourse.speckle.works) -- on [the chat](https://speckle-works.slack.com/join/shared_invite/enQtNjY5Mzk2NTYxNTA4LTU4MWI5ZjdhMjFmMTIxZDIzOTAzMzRmMTZhY2QxMmM1ZjVmNzJmZGMzMDVlZmJjYWQxYWU0MWJkYmY3N2JjNGI) - -Do join and introduce yourself! +The Speckle Community hangs out on [the forum](https://discourse.speckle.works), do join and introduce yourself & feel free to ask us questions! ## License From 1bcef9faf68aed1ddde94395d209231d61b10a8a Mon Sep 17 00:00:00 2001 From: Matteo Cominetti Date: Fri, 19 Feb 2021 18:40:56 +0000 Subject: [PATCH 27/41] docs: adds link to docs --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e3fcfec..3c5e3de 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Speckle Repo Management Templates -[![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Discourse users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiscourse.speckle.works&style=flat-square)](https://discourse.speckle.works) [![website](https://img.shields.io/badge/www-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) +[![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 @@ -17,6 +17,12 @@ This repo holds Speckle's: 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. From 83bca13c8b1f848337fd708404f112e0bc2f22d0 Mon Sep 17 00:00:00 2001 From: Dimitrie Stefanescu Date: Sun, 23 May 2021 16:28:34 +0100 Subject: [PATCH 28/41] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 3c5e3de..3faf406 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,10 @@ Please make sure you read the [contribution guidelines](.github/CONTRIBUTING.md) 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). From 1431e306b8fd88452ea10f03f2b596d56f31f7af Mon Sep 17 00:00:00 2001 From: Matteo Cominetti Date: Sat, 2 Oct 2021 17:02:55 +0100 Subject: [PATCH 29/41] Create open-issue.yml --- .github/workflows/open-issue.yml | 50 ++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 .github/workflows/open-issue.yml diff --git a/.github/workflows/open-issue.yml b/.github/workflows/open-issue.yml new file mode 100644 index 0000000..831d2b0 --- /dev/null +++ b/.github/workflows/open-issue.yml @@ -0,0 +1,50 @@ +name: Move new issues into Project + +on: + issues: + types: [opened] + +jobs: + track_issue: + runs-on: ubuntu-latest + steps: + - name: Get project data + env: + GITHUB_TOKEN: ${{secrets.GHPROJECT_TOKEN}} + ORGANIZATION: specklesystems + PROJECT_NUMBER: 9 + run: | + gh api graphql --header 'GraphQL-Features: projects_next_graphql' -f query=' + query($org: String!, $number: Int!) { + organization(login: $org){ + projectNext(number: $number) { + id + fields(first:20) { + nodes { + id + name + settings + } + } + } + } + }' -f org=$ORGANIZATION -F number=$PROJECT_NUMBER > project_data.json + + echo 'PROJECT_ID='$(jq '.data.organization.projectNext.id' project_data.json) >> $GITHUB_ENV + echo 'STATUS_FIELD_ID='$(jq '.data.organization.projectNext.fields.nodes[] | select(.name== "Status") | .id' project_data.json) >> $GITHUB_ENV + + - name: Add Issue to project + env: + GITHUB_TOKEN: ${{secrets.GHPROJECT_TOKEN}} + ISSUE_ID: ${{ github.event.issue.node_id }} + run: | + item_id="$( gh api graphql --header 'GraphQL-Features: projects_next_graphql' -f query=' + mutation($project:ID!, $id:ID!) { + addProjectNextItem(input: {projectId: $project, contentId: $id}) { + projectNextItem { + id + } + } + }' -f project=$PROJECT_ID -f id=$ISSUE_ID --jq '.data.addProjectNextItem.projectNextItem.id')" + + echo 'ITEM_ID='$item_id >> $GITHUB_ENV From 1c0d6ce8f436607fd2cd0dfc839adee2e2296a89 Mon Sep 17 00:00:00 2001 From: Matteo Cominetti Date: Sat, 2 Oct 2021 17:03:18 +0100 Subject: [PATCH 30/41] Create close-issue.yml --- .github/workflows/close-issue.yml | 78 +++++++++++++++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 .github/workflows/close-issue.yml diff --git a/.github/workflows/close-issue.yml b/.github/workflows/close-issue.yml new file mode 100644 index 0000000..094d6df --- /dev/null +++ b/.github/workflows/close-issue.yml @@ -0,0 +1,78 @@ +name: Update issue Status + +on: + issues: + types: [closed] + +jobs: + update_issue: + runs-on: ubuntu-latest + steps: + - name: Get project data + env: + GITHUB_TOKEN: ${{secrets.GHPROJECT_TOKEN}} + ORGANIZATION: specklesystems + PROJECT_NUMBER: 9 + run: | + gh api graphql --header 'GraphQL-Features: projects_next_graphql' -f query=' + query($org: String!, $number: Int!) { + organization(login: $org){ + projectNext(number: $number) { + id + fields(first:20) { + nodes { + id + name + settings + } + } + } + } + }' -f org=$ORGANIZATION -F number=$PROJECT_NUMBER > project_data.json + + echo 'PROJECT_ID='$(jq '.data.organization.projectNext.id' project_data.json) >> $GITHUB_ENV + echo 'STATUS_FIELD_ID='$(jq '.data.organization.projectNext.fields.nodes[] | select(.name== "Status") | .id' project_data.json) >> $GITHUB_ENV + + echo "$PROJECT_ID" + echo "$STATUS_FIELD_ID" + + echo 'DONE_ID='$(jq '.data.organization.projectNext.fields.nodes[] | select(.name== "Status") | .settings | fromjson | .options[] | select(.name== "Done") | .id' project_data.json) >> $GITHUB_ENV + echo "$DONE_ID" + + - name: Add Issue to project #it's already in the project, but we do this to get its node id! + env: + GITHUB_TOKEN: ${{secrets.GHPROJECT_TOKEN}} + ISSUE_ID: ${{ github.event.issue.node_id }} + run: | + item_id="$( gh api graphql --header 'GraphQL-Features: projects_next_graphql' -f query=' + mutation($project:ID!, $id:ID!) { + addProjectNextItem(input: {projectId: $project, contentId: $id}) { + projectNextItem { + id + } + } + }' -f project=$PROJECT_ID -f id=$ISSUE_ID --jq '.data.addProjectNextItem.projectNextItem.id')" + + echo 'ITEM_ID='$item_id >> $GITHUB_ENV + + - name: Update Status + env: + GITHUB_TOKEN: ${{secrets.GHPROJECT_TOKEN}} + ISSUE_ID: ${{ github.event.issue.node_id }} + run: | + gh api graphql --header 'GraphQL-Features: projects_next_graphql' -f query=' + mutation($project:ID!, $status:ID!, $id:ID!, $value:String!) { + set_status: updateProjectNextItemField( + input: { + projectId: $project + itemId: $id + fieldId: $status + value: $value + } + ) { + projectNextItem { + id + } + } + }' -f project=$PROJECT_ID -f status=$STATUS_FIELD_ID -f id=$ITEM_ID -f value=${{ env.DONE_ID }} + From 480ea91ebbcde22f8ada5cec522adc137b4241af Mon Sep 17 00:00:00 2001 From: Iain Sproat <68657+iainsproat@users.noreply.github.com> Date: Thu, 21 Jul 2022 12:43:28 +0100 Subject: [PATCH 31/41] Fixes: PR template updated to provide detailed instructions --- .github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md | 96 +++++++++++++++++--- 1 file changed, 81 insertions(+), 15 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md index c1701e0..2d1a264 100644 --- a/.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md @@ -1,25 +1,91 @@ -Description of PR... + + +## Description & motivation + + + +## Changes: + + -- [ ] Unit tests -- [ ] Documentation +## To-do before merge -## References + + +## Screenshots: + + + +## Validation of changes: + + + +## Checklist: + + + +- [ ] My pull request follows the guidelines in the Contributing document? + +- [ ] My pull request does not duplicate any other open [Pull Requests](../../../pulls) for the same update/change? + +- [ ] My commits are related to the pull request and do not amend unrelated code or documentation. + +- [ ] My code follows a similar style to existing code. + +- [ ] I have added appropriate tests. + +- [ ] I have updated or added relevant documentation. From 46773aa9d329ec24efe080612daf5c5de2aa5dbd Mon Sep 17 00:00:00 2001 From: Iain Sproat <68657+iainsproat@users.noreply.github.com> Date: Thu, 21 Jul 2022 12:54:41 +0100 Subject: [PATCH 32/41] Add link to speckle-server contribution guide --- .github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md index 2d1a264..7316ac9 100644 --- a/.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md @@ -78,14 +78,9 @@ addressed, and remove any items that are not relevant to this PR. --> -- [ ] My pull request follows the guidelines in the Contributing document? - +- [ ] My pull request follows the guidelines in the [Contributing guide](https://github.com/specklesystems/speckle-server/blob/main/CONTRIBUTING.md)? - [ ] My pull request does not duplicate any other open [Pull Requests](../../../pulls) for the same update/change? - - [ ] My commits are related to the pull request and do not amend unrelated code or documentation. - - [ ] My code follows a similar style to existing code. - - [ ] I have added appropriate tests. - - [ ] I have updated or added relevant documentation. From 1e7291277e15309397c3cea2bac0a46540076156 Mon Sep 17 00:00:00 2001 From: Iain Sproat <68657+iainsproat@users.noreply.github.com> Date: Thu, 21 Jul 2022 13:06:25 +0100 Subject: [PATCH 33/41] Fix link to relative to the repo pull requests --- .github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md index 7316ac9..637e5f6 100644 --- a/.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md @@ -79,7 +79,7 @@ addressed, and remove any items that are not relevant to this PR. --> - [ ] My pull request follows the guidelines in the [Contributing guide](https://github.com/specklesystems/speckle-server/blob/main/CONTRIBUTING.md)? -- [ ] My pull request does not duplicate any other open [Pull Requests](../../../pulls) for the same update/change? +- [ ] My pull request does not duplicate any other open [Pull Requests](../../pulls) for the same update/change? - [ ] My commits are related to the pull request and do not amend unrelated code or documentation. - [ ] My code follows a similar style to existing code. - [ ] I have added appropriate tests. From 68036ee1307eadfbf396adf1b80e454fce591edb Mon Sep 17 00:00:00 2001 From: Iain Sproat <68657+iainsproat@users.noreply.github.com> Date: Thu, 21 Jul 2022 16:56:10 +0100 Subject: [PATCH 34/41] Feature: separates issue template into bugs and feature requests * Provides checklist for both issue templates * Hides instructions in comments --- .github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md | 25 ------ .github/ISSUE_TEMPLATE/bug_report.md | 100 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 61 +++++++++++++ 3 files changed, 161 insertions(+), 25 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md deleted file mode 100644 index 26c8898..0000000 --- a/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -name: New issue -about: Create a report to help us improve -title: -labels: -assignees: ---- - -If it's your first time here - or you forgot about them - make sure you read the [contribution guidelines](CONTRIBUTING.md), and then feel free to delete this line! - -### Expected vs. Actual Behavior - -Describe the problem here. - -### Reproduction Steps & System Config (win, osx, web, etc.) - -Let us know how we can reproduce this, and attach relevant files (if any). - -### Proposed Solution (if any) - -Let us know what how you would solve this. - -#### Optional: Affected Projects - -Does this issue propagate to other dependencies or dependents? If so, list them here! diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..f66e579 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,100 @@ +--- +name: Bug report +about: Help improve Speckle! +title: '' +labels: bug +assignees: '' +--- + + + +## Prerequisites + + + +- [ ] I checked the [documentation](https://speckle.guide/) and found no answer. +- [ ] I checked to make sure that this issue has not [already been filed](../../issues) +- [ ] I checked the [community forum](https://speckle.community/) for related discussions. +- [ ] I'm reporting the issue to the correct repository (see also [speckle-server](https://github.com/specklesystems/speckle-server), [speckle-sharp](https://github.com/specklesystems/speckle-sharp), [specklepy](https://github.com/specklesystems/specklepy), [speckle-docs](https://github.com/specklesystems/speckle-docs), and [others](https://github.com/orgs/specklesystems/repositories)) + +## What package are you referring to? + + + +## Describe the bug + + + +## To Reproduce + + + +## Expected behavior + + + +## Screenshots + + +## System Info +If applicable, please fill in the below details - they help a lot! + +### Desktop (please complete the following information): + +- OS: [e.g. iOS] +- Browser [e.g. chrome, safari] +- Version [e.g. 22] + +### Smartphone (please complete the following information): + +- Device: [e.g. iPhone6] +- OS: [e.g. iOS8.1] +- Browser [e.g. stock browser, safari] +- Version [e.g. 22] + + + +## Failure Logs + + + +## Additional context + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..82f5a16 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,61 @@ +--- +name: Feature request +about: Suggest an idea for Speckle! +title: '' +labels: enhancement, question +assignees: '' +--- + + + +## Prerequisites + + + +- [ ] I checked the [documentation](https://speckle.guide/) and found no answer. +- [ ] I checked to make sure that this issue has not [already been filed](../../issues). Please show your support for existing issues by liking it :+1:. +- [ ] I checked the [community forum](https://speckle.community/) for related discussions. +- [ ] I'm requesting the feature to the correct repository (see also [speckle-server](https://github.com/specklesystems/speckle-server), [speckle-sharp](https://github.com/specklesystems/speckle-sharp), [specklepy](https://github.com/specklesystems/specklepy), [speckle-docs](https://github.com/specklesystems/speckle-docs), and [others](https://github.com/orgs/specklesystems/repositories)) + +## What package are you referring to? + + +## Is your feature request related to a problem? Please describe. + + +## Describe the solution you'd like + + +## Describe alternatives you've considered + + +## Additional context + + +## Related issues or community discussions + From aa8c7b6f42532881b515f77ec1f9750d55ea4d0a Mon Sep 17 00:00:00 2001 From: Iain Sproat <68657+iainsproat@users.noreply.github.com> Date: Thu, 21 Jul 2022 17:03:08 +0100 Subject: [PATCH 35/41] Add link to contribution guidelines --- .github/ISSUE_TEMPLATE/bug_report.md | 1 + .github/ISSUE_TEMPLATE/feature_request.md | 1 + 2 files changed, 2 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index f66e579..c1501b3 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -23,6 +23,7 @@ Please answer the following questions before submitting an issue. --> +- [ ] I read the [contribution guidelines](https://github.com/specklesystems/speckle-server/blob/main/CONTRIBUTING.md) - [ ] I checked the [documentation](https://speckle.guide/) and found no answer. - [ ] I checked to make sure that this issue has not [already been filed](../../issues) - [ ] I checked the [community forum](https://speckle.community/) for related discussions. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 82f5a16..654ee4f 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -23,6 +23,7 @@ Please answer the following questions before submitting an issue. --> +- [ ] I read the [contribution guidelines](https://github.com/specklesystems/speckle-server/blob/main/CONTRIBUTING.md) - [ ] I checked the [documentation](https://speckle.guide/) and found no answer. - [ ] I checked to make sure that this issue has not [already been filed](../../issues). Please show your support for existing issues by liking it :+1:. - [ ] I checked the [community forum](https://speckle.community/) for related discussions. From 8f3a6838518629c3bf592d96996509c874df715c Mon Sep 17 00:00:00 2001 From: Iain Sproat <68657+iainsproat@users.noreply.github.com> Date: Thu, 21 Jul 2022 17:08:34 +0100 Subject: [PATCH 36/41] Retain some sections from previous issue template --- .github/ISSUE_TEMPLATE/bug_report.md | 13 +++++++++++-- .github/ISSUE_TEMPLATE/feature_request.md | 3 +++ 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index c1501b3..a545810 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -79,8 +79,6 @@ If applicable, please fill in the below details - they help a lot! - Browser [e.g. stock browser, safari] - Version [e.g. 22] - - ## Failure Logs + +## Proposed Solution (if any) + + + +#### Optional: Affected Projects + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 654ee4f..dba60ac 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -52,6 +52,9 @@ A clear and concise description of any alternative solutions or features you've ## Additional context ## Related issues or community discussions From 0d1c2735d86f82bd0e3e8466898b941dbc18ee48 Mon Sep 17 00:00:00 2001 From: Iain Sproat <68657+iainsproat@users.noreply.github.com> Date: Thu, 21 Jul 2022 17:14:16 +0100 Subject: [PATCH 37/41] checklist is clearer --- .github/ISSUE_TEMPLATE/bug_report.md | 4 ++-- .github/ISSUE_TEMPLATE/feature_request.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index a545810..d60dbb0 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -25,8 +25,8 @@ Please answer the following questions before submitting an issue. - [ ] I read the [contribution guidelines](https://github.com/specklesystems/speckle-server/blob/main/CONTRIBUTING.md) - [ ] I checked the [documentation](https://speckle.guide/) and found no answer. -- [ ] I checked to make sure that this issue has not [already been filed](../../issues) -- [ ] I checked the [community forum](https://speckle.community/) for related discussions. +- [ ] I checked [existing issues](../issues?q=is%3Aissue) and found no similar issue. +- [ ] I checked the [community forum](https://speckle.community/) for related discussions and found no answer. - [ ] I'm reporting the issue to the correct repository (see also [speckle-server](https://github.com/specklesystems/speckle-server), [speckle-sharp](https://github.com/specklesystems/speckle-sharp), [specklepy](https://github.com/specklesystems/specklepy), [speckle-docs](https://github.com/specklesystems/speckle-docs), and [others](https://github.com/orgs/specklesystems/repositories)) ## What package are you referring to? diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index dba60ac..f8fc82c 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -25,8 +25,8 @@ Please answer the following questions before submitting an issue. - [ ] I read the [contribution guidelines](https://github.com/specklesystems/speckle-server/blob/main/CONTRIBUTING.md) - [ ] I checked the [documentation](https://speckle.guide/) and found no answer. -- [ ] I checked to make sure that this issue has not [already been filed](../../issues). Please show your support for existing issues by liking it :+1:. -- [ ] I checked the [community forum](https://speckle.community/) for related discussions. +- [ ] I checked [existing issues](../issues?q=is%3Aissue) and found no similar issue. +- [ ] I checked the [community forum](https://speckle.community/) for related discussions and found no answer. - [ ] I'm requesting the feature to the correct repository (see also [speckle-server](https://github.com/specklesystems/speckle-server), [speckle-sharp](https://github.com/specklesystems/speckle-sharp), [specklepy](https://github.com/specklesystems/specklepy), [speckle-docs](https://github.com/specklesystems/speckle-docs), and [others](https://github.com/orgs/specklesystems/repositories)) ## What package are you referring to? From 8d320abe002601fa7a7c01085e913e7137ee677d Mon Sep 17 00:00:00 2001 From: Iain Sproat <68657+iainsproat@users.noreply.github.com> Date: Mon, 8 Aug 2022 09:41:18 +0100 Subject: [PATCH 38/41] style: tidy newlines and other small formatting --- .github/ISSUE_TEMPLATE/bug_report.md | 3 +++ .github/ISSUE_TEMPLATE/feature_request.md | 6 ++++++ .github/workflows/close-issue.yml | 9 ++++----- .github/workflows/open-issue.yml | 4 ++-- README.md | 2 +- 5 files changed, 16 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index d60dbb0..7d234bc 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -59,11 +59,13 @@ A clear and concise description of what you expected to happen. --> ## Screenshots + ## System Info + If applicable, please fill in the below details - they help a lot! ### Desktop (please complete the following information): @@ -105,6 +107,7 @@ Let us know what how you would solve this. --> #### Optional: Affected Projects + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index f8fc82c..da265de 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -30,26 +30,31 @@ Please answer the following questions before submitting an issue. - [ ] I'm requesting the feature to the correct repository (see also [speckle-server](https://github.com/specklesystems/speckle-server), [speckle-sharp](https://github.com/specklesystems/speckle-sharp), [specklepy](https://github.com/specklesystems/specklepy), [speckle-docs](https://github.com/specklesystems/speckle-docs), and [others](https://github.com/orgs/specklesystems/repositories)) ## What package are you referring to? + ## Is your feature request related to a problem? Please describe. + ## Describe the solution you'd like + ## Describe alternatives you've considered + ## Additional context + ## Related issues or community discussions + -## To-do before merge +## To-do before merge: @@ -84,3 +84,19 @@ addressed, and remove any items that are not relevant to this PR. - [ ] My code follows a similar style to existing code. - [ ] I have added appropriate tests. - [ ] I have updated or added relevant documentation. + +## References + +