diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..e8e6e22 --- /dev/null +++ b/.github/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 diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..b7fa3e3 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,50 @@ +# 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. + +- 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! + +## 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! + +> 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 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..1efeba6 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/PR_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 new file mode 100644 index 0000000..21a1d7a --- /dev/null +++ b/.github/workflows/close-issue.yml @@ -0,0 +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 }} 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/README.md b/README.md index ded5228..d9babce 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ ![xunit2](https://user-images.githubusercontent.com/2679513/88958499-77809980-d298-11ea-84b6-e0749790ffc5.gif) +[![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/) - -## Intro +## Introduction An xUnit runner for Autodesk Revit. @@ -194,3 +194,16 @@ xUnitRevit was developed to help us develop a better Speckle 2.0 connector for R Want to suggest a feature, report a bug, submit a PR? Please open an issue to discuss first! +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 + +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 MIT 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). \ No newline at end of file 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!