Skip to content

Commit

Permalink
add new files needed for eclipse
Browse files Browse the repository at this point in the history
  • Loading branch information
egekorkan committed Mar 11, 2023
1 parent 2eed25d commit df0729e
Show file tree
Hide file tree
Showing 12 changed files with 375 additions and 41 deletions.
9 changes: 9 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -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
34 changes: 34 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -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
7 changes: 7 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -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
7 changes: 7 additions & 0 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"trailingComma": "es5",
"printWidth": 120,
"singleQuote": false,
"tabWidth": 4,
"endOfLine": "lf"
}
47 changes: 47 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -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 [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 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
114 changes: 114 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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 "<your Eclipse account 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:

```
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
```

- `<type>`: A noun specifying the type of change, followed by a colon and a space. The types allowed are:
- `feat`: A new feature
- `fix`: A bug fix
- `refactor`: Code change that neither fixes a bug or adds a feature (not relevant for end user)
- `perf`: Change improves performance
- `style`: Change does not affect the code (e.g., formatting, whitespaces)
- `test`: Adding missing tests
- `chore`: Change of build process or auxiliary tools
- `docs`: Documentation only changes
- `<scope>`: Optional. A term of free choice specifying the place of the commit change, enclosed in parentheses. Examples:
- `feat(binding-coap): ...`
- `fix(cli): ...`
- `docs: ...` (no scope, as it is optional)
- `<subject>`: A succinct description of the change, e.g., `add support for magic`
- Use the imperative, present tense: "add", not "added" nor "adds"
- Do not capitalize first letter: "add", not "Add"
- No dot (.) at the end
- `<body>`: Optional. Can include the motivation for the change and contrast this with previous behavior.
- Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes"
- `<footer>`: Optional. Can be used to automatically close GitHub Issues and to document breaking changes.
- The prefix `BREAKING CHANGE: ` indicates API breakage (corresponding to a major version change) and everything after is a description what changed and what needs to be done to migrate
- GitHub Issue controls such as `Fixes #123` or `Closes #4711` must come before a potential `BREAKING CHANGE: `.

Examples:

```
docs: improve how to contribute
```

```
feat(core): add support for magic
Closes #110
```

```
feat(core): add support for magic
Simplify the API by reducing the number of functions.
Closes #110
BREAKING CHANGE: Change all calls to the API to the new `do()` function.
```

## Coding Style

Eclipse Thingweb uses `eslint` and `prettier` to enforce a consistent coding style.
A Github Actions workflow checks for each Pull Request if the coding style is followed and creates annotations in the "files changed" tab for each warning that is emitted during this linting process.
To avoid such warnings, please use `npm run lint` for linting your code and `npm run format` to automatically apply fixes before committing any changes.

## Pull Requests and Feature Branches

- Do not merge with master while developing a new feature or providing a fix in a new branch
- Do a rebase if updates in the master such as a fix are required:

```
git checkout master && git pull && git checkout - && git rebase master
```

- Pull Requests are merged using rebase

## Contact

Contact the project developers via the project's "dev" list.

- https://dev.eclipse.org/mailman/listinfo/thingweb-dev
15 changes: 9 additions & 6 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
MIT license
Copyright (c) 2023 Contributors to the Eclipse Foundation

Copyright 2021 Technical University of Munich, Associate Professorship of Embedded Systems and Internet of Things
See the NOTICE file(s) distributed with this work for additional
information regarding copyright ownership.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
This program and the accompanying materials are made available under the
terms of the Eclipse Public License v. 2.0 which is available at
http://www.eclipse.org/legal/epl-2.0, or the W3C Software Notice and
Document License (2015-05-13) which is available at
https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document.

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
SPDX-License-Identifier: EPL-2.0 OR W3C-20150513
43 changes: 43 additions & 0 deletions NOTICE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Notices for Eclipse Thingweb

This content is produced and maintained by the Eclipse Thingweb project.

- Project home: https://projects.eclipse.org/projects/iot.thingweb

## Trademarks

Eclipse Thingweb is a trademark of the Eclipse Foundation.

## Copyright

All content is the property of the respective authors or their employers. For
more information regarding authorship of content, please consult the listed
source code repository logs.

Note: The {year} in the copyright statements is the year in which the content
was created (e.g. “2004”). A range of years is not used.

## Declared Project Licenses

This program and the accompanying materials are made available under the terms
of the Eclipse Public License v. 2.0 which is available at
http://www.eclipse.org/legal/epl-2.0, or the W3C Software Notice and Document
License (2015-05-13) which is available at
https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document.

SPDX-License-Identifier: EPL-2.0 OR W3C-20150513

## Source Code

The project maintains the following source code repositories:

## Third-party Content

## Cryptography

Content may contain encryption software. The country in which you are currently
may have restrictions on the import, possession, and use, and/or re-export to
another country, of encryption software. BEFORE using any encryption software,
please check the country's laws, regulations and policies concerning the import,
possession, or use, and re-export of encryption software, to see if this is
permitted.
Loading

0 comments on commit df0729e

Please sign in to comment.