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..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 deleted file mode 100644 index c1701e0..0000000 --- a/.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md +++ /dev/null @@ -1,25 +0,0 @@ -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/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..1efeba6 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,102 @@ + + +## 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. + +## References + + diff --git a/.github/workflows/close-issue.yml b/.github/workflows/close-issue.yml index 094d6df..21a1d7a 100644 --- a/.github/workflows/close-issue.yml +++ b/.github/workflows/close-issue.yml @@ -32,10 +32,10 @@ jobs: 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" @@ -52,9 +52,9 @@ jobs: } } }' -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}} @@ -75,4 +75,3 @@ jobs: } } }' -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 index 831d2b0..0c0943c 100644 --- a/.github/workflows/open-issue.yml +++ b/.github/workflows/open-issue.yml @@ -32,7 +32,7 @@ jobs: 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}} @@ -46,5 +46,5 @@ jobs: } } }' -f project=$PROJECT_ID -f id=$ISSUE_ID --jq '.data.addProjectNextItem.projectNextItem.id')" - + echo 'ITEM_ID='$item_id >> $GITHUB_ENV diff --git a/README.md b/README.md index 62715f5..c7da9d8 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ It may be helpful to know where the local accounts and object cache dbs are stor ## Contributing -Please make sure you read the [contribution guidelines](.github/CONTRIBUTING.md) for an overview of the best practices we try to follow. +Please make sure you read the [contribution guidelines](.github/CONTRIBUTING.md) and [code of conduct](.github/CODE_OF_CONDUCT.md) for an overview of the practices we try to follow. ## Community 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!