From 2ea6fdd32e9c03703864a20e0613176b73821e48 Mon Sep 17 00:00:00 2001 From: Alan Rynne Date: Tue, 9 Aug 2022 11:51:29 +0200 Subject: [PATCH] Merge pull request #17 from specklesystems/github-template-update --- .../CODE_OF_CONDUCT.md | 26 +-- CONTRIBUTING.md => .github/CONTRIBUTING.md | 23 +-- .github/ISSUE_TEMPLATE/bug_report.md | 113 +++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 71 ++++++++ .github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md | 86 ++++++++++ .github/workflows/close-issue.yml | 155 +++++++++--------- .github/workflows/open-issue.yml | 50 ++++++ LICENSE | 2 +- README.md | 13 +- SECURITY.md | 12 ++ 10 files changed, 444 insertions(+), 107 deletions(-) rename CODE_OF_CONDUCT.md => .github/CODE_OF_CONDUCT.md (82%) rename CONTRIBUTING.md => .github/CONTRIBUTING.md (86%) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md create mode 100644 .github/workflows/open-issue.yml create mode 100644 SECURITY.md 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 86% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md index c6a1674..b7fa3e3 100644 --- a/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/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..7d234bc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,113 @@ +--- +name: Bug report +about: Help improve Speckle! +title: '' +labels: bug +assignees: '' +--- + + + +## Prerequisites + + + +- [ ] 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 [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? + + + +## 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 + + + +## Proposed Solution (if any) + + + +#### Optional: Affected Projects + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..da265de --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,71 @@ +--- +name: Feature request +about: Suggest an idea for Speckle! +title: '' +labels: enhancement, question +assignees: '' +--- + + + +## Prerequisites + + + +- [ ] 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 [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? + + + +## 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 + + diff --git a/.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md new file mode 100644 index 0000000..637e5f6 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md @@ -0,0 +1,86 @@ + + +## Description & motivation + + + +## Changes: + + + +## To-do before merge + + + +## Screenshots: + + + +## Validation of changes: + + + +## Checklist: + + + +- [ ] 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. diff --git a/.github/workflows/close-issue.yml b/.github/workflows/close-issue.yml index 571593a..21a1d7a 100644 --- a/.github/workflows/close-issue.yml +++ b/.github/workflows/close-issue.yml @@ -1,78 +1,77 @@ -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 }} - \ No newline at end of file +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 }} diff --git a/.github/workflows/open-issue.yml b/.github/workflows/open-issue.yml new file mode 100644 index 0000000..0c0943c --- /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 diff --git a/LICENSE b/LICENSE index 261eeb9..f83b45e 100644 --- a/LICENSE +++ b/LICENSE @@ -186,7 +186,7 @@ same "printed page" as the copyright notice for easier identification within third-party archives. - Copyright [yyyy] [name of copyright owner] + 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. diff --git a/README.md b/README.md index 25fdd38..af29ec9 100644 --- a/README.md +++ b/README.md @@ -76,11 +76,16 @@ Quite easy: ## Contributing -Before embarking on submitting a patch, please make sure you read: +Please make sure you read the [contribution guidelines](.github/CONTRIBUTING.md) and [Code of Conduct](.github/CODE_OF_CONDUCT.md) for an overview of the best practices we try to follow. -- [Contribution Guidelines](CONTRIBUTING.md), -- [Code of Conduct](CODE_OF_CONDUCT.md) +## Community + +The Speckle Community hangs out on [the forum](https://discourse.speckle.works), do join and introduce yourself & feel free to ask us questions! + +## Security + +For any security vulnerabilities or concerns, please contact us directly at security[at]speckle.systems. ## License -Unless otherwise described, the code in this repository is licensed under the Apache-2.0 license. +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). diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..6485c32 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,12 @@ +# Security Policy + +## Supported Versions + +| Version | Supported | +| ------- | ------------------ | +| 2.2.+ | :white_check_mark: | +| < 2.2 | :x: | + +## Reporting a Vulnerability + +Hi! If you've found something off, we'd be more than happy if you would report it via security@speckle.systems. We will work together with you to correctly identify the cause and implement a fix. Thanks for helping make Speckle safer!