From df0729e6bbe1e059a1bce6573a6be6e570014eed Mon Sep 17 00:00:00 2001 From: Ege Korkan Date: Sat, 11 Mar 2023 18:03:26 +0100 Subject: [PATCH] add new files needed for eclipse --- .editorconfig | 9 ++++ .gitattributes | 34 +++++++++++++ .prettierignore | 7 +++ .prettierrc.json | 7 +++ CODE_OF_CONDUCT.md | 47 ++++++++++++++++++ CONTRIBUTING.md | 114 +++++++++++++++++++++++++++++++++++++++++++ LICENSE.md | 15 +++--- NOTICE.md | 43 ++++++++++++++++ README.md | 45 ++++++++--------- SECURITY.md | 51 +++++++++++++++++-- license.template.txt | 14 ++++++ package.json | 30 +++++++++--- 12 files changed, 375 insertions(+), 41 deletions(-) create mode 100644 .editorconfig create mode 100644 .gitattributes create mode 100644 .prettierignore create mode 100644 .prettierrc.json create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 NOTICE.md create mode 100644 license.template.txt diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 000000000..3d5977e9d --- /dev/null +++ b/.editorconfig @@ -0,0 +1,9 @@ +root = true + +[{src,test}/**.{ts,json,js}] +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true +indent_style = space +indent_size = 4 \ No newline at end of file diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 000000000..75c48d21c --- /dev/null +++ b/.gitattributes @@ -0,0 +1,34 @@ +# Set default behaviour, in case users don't have core.autocrlf set. +* text=auto + +# Explicitly declare text files we want to always be normalized and converted +# to native line endings on checkout. + +# Declare files that will always have LF line endings on checkout. +*.c text eol=lf +*.css text eol=lf +*.cpp text eol=lf +.editorconfig text eol=lf +.gitattributes text eol=lf +.gitignore text eol=lf +.gitmodules text eol=lf +*.gyp text eol=lf +*.h text eol=lf +*.hpp text eol=lf +*.js text eol=lf +*.ts text eol=lf +*.json text eol=lf +LICENSE text eol=lf +*.md text eol=lf +*.svg text eol=lf +*.sh text eol=lf + +# Declare files that will always have CRLF line endings on checkout. +*.bat text eol=crlf +*.cmd text eol=crlf + +# Denote all files that are truly binary and should not be modified. +*.gif binary +*.jpg binary +*.node binary +*.png binary diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 000000000..b2789364c --- /dev/null +++ b/.prettierignore @@ -0,0 +1,7 @@ +package-lock.json +**/dist +coverage +.nyc_output +**/out +packages/td_to_openAPI/examples/openapi.yaml +packages/td_to_asyncapi/examples/asyncapi.yaml \ No newline at end of file diff --git a/.prettierrc.json b/.prettierrc.json new file mode 100644 index 000000000..8c7004572 --- /dev/null +++ b/.prettierrc.json @@ -0,0 +1,7 @@ +{ + "trailingComma": "es5", + "printWidth": 120, + "singleQuote": false, + "tabWidth": 4, + "endOfLine": "lf" +} diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..c2135ea58 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,47 @@ +# Community Code of Conduct + +**Version 1.2 +August 19, 2020** + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as community members, contributors, committers, and project leaders pledge to make 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 + +With the support of the Eclipse Foundation staff (the “Staff”), project committers and leaders 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 committers and leaders 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 within all project spaces, and it also applies when an individual is representing the Eclipse Foundation project or its community in public spaces. Examples of representing a project or community include posting via an official social media account, or acting as a project representative at an online or offline event. Representation of a project may be further defined and clarified by project committers, leaders, or the EMO. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the Staff at codeofconduct@eclipse.org. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The Staff is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + +Project committers or leaders who do not follow the Code of Conduct in good faith may face temporary or permanent repercussions as determined by the Staff. + +## 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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..172dc53d1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,114 @@ +# Contributing to Eclipse Thingweb + +Thanks for your interest in this project. General information +regarding source code management, builds, coding standards, and +more can be found here: + +- https://projects.eclipse.org/projects/iot.thingweb/developer + +## Legal Requirements + +Thingweb is an [Eclipse IoT](https://iot.eclipse.org) project and as such is governed by the Eclipse Development process. +This process helps us in creating great open source software within a safe legal framework. + +Thus, before your contribution can be accepted by the project team, contributors must electronically sign the [Eclipse Contributor Agreement (ECA)](http://www.eclipse.org/legal/ECA.php) and follow these preliminary steps: + +- Obtain an [Eclipse Foundation account](https://accounts.eclipse.org/) + - Anyone who currently uses Eclipse Bugzilla or Gerrit systems already has one of those + - Newcomers can [create a new account](https://accounts.eclipse.org/user/register?destination=user) +- Add your GiHub username to your Eclipse Foundation account + - ([Log into Eclipse](https://accounts.eclipse.org/)) + - Go to the _Edit Profile_ tab + - Fill in the _GitHub ID_ under _Social Media Links_ and save +- Sign the [Eclipse Contributor Agreement](http://www.eclipse.org/legal/ECA.php) + - ([Log into Eclipse](https://accounts.eclipse.org/)) + - If the _Status_ entry _Eclipse Contributor Agreement_ has a green checkmark, the ECA is already signed + - If not, go to the _Eclipse Contributor Agreement_ tab or follow the corresponding link under _Status_ + - Fill out the form and sign it electronically +- Sign-off every commit using the same email address used for your Eclipse account + - Set the Git user email address with `git config user.email ""` + - Add the `-s` flag when you make the commit(s), e.g. `git commit -s -m "feat: add support for magic"` +- Open a [Pull Request](https://github.com/eclipse/thingweb.td-playground/pulls) + +For more information, please see the Eclipse Committer Handbook: +https://www.eclipse.org/projects/handbook/#resources-commit + +## Commits + +Eclipse Thingweb uses Conventional Changelog, which structure Git commit messages in a way that allows automatic generation of changelogs. +Commit messages must be structured as follows: + +``` +(): + + + +