-
Notifications
You must be signed in to change notification settings - Fork 187
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update .github etc. from latest template (#901)
* Initial commit * Create CODE_OF_CONDUCT.md * Create CONTRIBUTING.MD * Update CODE_OF_CONDUCT.md adds authoritative source notice to this repo * Create ISSUE_TEMPLATE.md * Update CODE_OF_CONDUCT.md * Update and rename CONTRIBUTING.MD to CONTRIBUTING.md * Update README.md adds basic default social badges - discourse and twitter * Update README.md * Update README.md * Update README.md * Update README.md * Create LICENSE * Update README.md * Update README.md * Update CONTRIBUTING.md fixes link * Update CODE_OF_CONDUCT.md * docs: add slack link and badge * Update README.md * fix: link and typos * fix: more links * refactor: moved files to .github/ folder * feat: added PR template Updated docs to reflect it. * fix: updated old link * fix: added yaml frontmatter block to issue template * docs: removes links to slack * docs: adds link to docs * Update README.md * Create open-issue.yml * Create close-issue.yml * Fixes: PR template updated to provide detailed instructions * Add link to speckle-server contribution guide * Fix link to relative to the repo pull requests * Feature: separates issue template into bugs and feature requests * Provides checklist for both issue templates * Hides instructions in comments * Add link to contribution guidelines * Retain some sections from previous issue template * checklist is clearer * style: tidy newlines and other small formatting * Retain previous README * Capitalise README to match upstream template (and prevent future git conflicts) Co-authored-by: Dimitrie Stefanescu <[email protected]> Co-authored-by: izzy lyseggen <[email protected]> Co-authored-by: Matteo Cominetti <[email protected]> Co-authored-by: Alan Rynne <[email protected]> Co-authored-by: Alan Rynne <[email protected]> Co-authored-by: Matteo Cominetti <[email protected]>
- Loading branch information
1 parent
81bed0c
commit df79267
Showing
5 changed files
with
256 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 [email protected]. 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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). | ||
|
||
🙌❤️💙💚💜🙌 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.