From b2945ad3ff81f7ff8cc88244460fd392c3bd8b92 Mon Sep 17 00:00:00 2001 From: Matteo Cominetti Date: Wed, 6 Jan 2021 16:48:45 +0000 Subject: [PATCH] feat: removes links to slack --- .github/CONTRIBUTING.md | 23 ++++++++++++----------- README.md | 21 +++++++-------------- 2 files changed, 19 insertions(+), 25 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c6a16747..b7fa3e30 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 696880c3..e2366b84 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # speckle-py 🥧 -[![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 @@ -9,9 +8,10 @@ ## Developing & Debugging -To get started, create a virtual environment and pip install the requirements. +To get started, create a virtual environment and pip install the requirements. on windows: + ``` python -m venv venv venv\Scripts\activate @@ -26,9 +26,7 @@ source venv/bin/activate pip install -r requirements.txt ``` - - -## Overview of functionality +## Overview of functionality The `SpeckleClient` is the entry point for interacting with the GraphQL API. You'll need to have a running server to use this. @@ -96,7 +94,7 @@ If you use the `operations`, you will not need to interact with the serializer d ```py transport = MemoryTransport() -# this serialises the object and sends it to the transport +# this serialises the object and sends it to the transport hash = operations.send(base=base_obj, transports=[transport]) # if the object had detached objects, you can see these as well @@ -114,7 +112,7 @@ test_base = Base() test_base.testing = "a test base obj" # run it through the serialiser -s = BaseObjectSerializer() +s = BaseObjectSerializer() hash, obj = s.traverse_base(test_base) # send it to the server @@ -131,12 +129,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