Skip to content

Commit c64bd50

Browse files
SergioCasCebSergioCasCeb
committed
fixed feedback text and size, feedback text now fully hides after a while, links fixed, modify the community button for an adopter button, adopters section added to the read me, fixed code snipets indentation, added new description to the tools, added 2 new tools, modify the tools grid style and restored missing files
1 parent e8b0024 commit c64bd50

18 files changed

+635
-375
lines changed

‎CODE_OF_CONDUCT.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Community Code of Conduct
2+
3+
**Version 1.2
4+
August 19, 2020**
5+
6+
## Our Pledge
7+
8+
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.
9+
10+
## Our Standards
11+
12+
Examples of behavior that contributes to creating a positive environment include:
13+
14+
- Using welcoming and inclusive language
15+
- Being respectful of differing viewpoints and experiences
16+
- Gracefully accepting constructive criticism
17+
- Focusing on what is best for the community
18+
- Showing empathy towards other community members
19+
20+
Examples of unacceptable behavior by participants include:
21+
22+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
23+
- Trolling, insulting/derogatory comments, and personal or political attacks
24+
- Public or private harassment
25+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
26+
- Other conduct which could reasonably be considered inappropriate in a professional setting
27+
28+
## Our Responsibilities
29+
30+
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.
31+
32+
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.
33+
34+
## Scope
35+
36+
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.
37+
38+
## Enforcement
39+
40+
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.
41+
42+
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.
43+
44+
## Attribution
45+
46+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
47+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

‎CONTRIBUTING.md

+102
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# Contributing to Eclipse Thingweb
2+
3+
Thanks for your interest in this project. General information
4+
regarding source code management, builds, coding standards, and
5+
more can be found here:
6+
7+
* https://projects.eclipse.org/projects/iot.thingweb/developer
8+
9+
## Legal Requirements
10+
11+
Thingweb is an [Eclipse IoT](https://iot.eclipse.org) project and as such is governed by the Eclipse Development process.
12+
This process helps us in creating great open source software within a safe legal framework.
13+
14+
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:
15+
16+
* Obtain an [Eclipse Foundation account](https://accounts.eclipse.org/)
17+
* Anyone who currently uses Eclipse Bugzilla or Gerrit systems already has one of those
18+
* Newcomers can [create a new account](https://accounts.eclipse.org/user/register?destination=user)
19+
* Add your GiHub username to your Eclipse Foundation account
20+
* ([Log into Eclipse](https://accounts.eclipse.org/))
21+
* Go to the *Edit Profile* tab
22+
* Fill in the *GitHub ID* under *Social Media Links* and save
23+
* Sign the [Eclipse Contributor Agreement](http://www.eclipse.org/legal/ECA.php)
24+
* ([Log into Eclipse](https://accounts.eclipse.org/))
25+
* If the *Status* entry *Eclipse Contributor Agreement* has a green checkmark, the ECA is already signed
26+
* If not, go to the *Eclipse Contributor Agreement* tab or follow the corresponding link under *Status*
27+
* Fill out the form and sign it electronically
28+
* Sign-off every commit using the same email address used for your Eclipse account
29+
* Set the Git user email address with `git config user.email "<your Eclipse account email>"`
30+
* Add the `-s` flag when you make the commit(s), e.g. `git commit -s -m "feat: add support for magic"`
31+
* Open a [Pull Request](https://github.com/eclipse-thingweb/node-wot/pulls)
32+
33+
For more information, please see the Eclipse Committer Handbook:
34+
https://www.eclipse.org/projects/handbook/#resources-commit
35+
36+
## Commits
37+
38+
Eclipse Thingweb uses Conventional Changelog, which structure Git commit messages in a way that allows automatic generation of changelogs.
39+
Commit messages must be structured as follows:
40+
```
41+
<type>(<scope>): <subject>
42+
<BLANK LINE>
43+
<body>
44+
<BLANK LINE>
45+
<footer>
46+
```
47+
48+
* `<type>`: A noun specifying the type of change, followed by a colon and a space. The types allowed are:
49+
* `feat`: A new feature
50+
* `fix`: A bug fix
51+
* `refactor`: Code change that neither fixes a bug or adds a feature (not relevant for end user)
52+
* `perf`: Change improves performance
53+
* `style`: Change does not affect the code (e.g., formatting, whitespaces)
54+
* `test`: Adding missing tests
55+
* `chore`: Change of build process or auxiliary tools
56+
* `docs`: Documentation only changes
57+
* `<scope>`: Optional. A term of free choice specifying the place of the commit change, enclosed in parentheses. Examples:
58+
* `feat(binding-coap): ...`
59+
* `fix(cli): ...`
60+
* `docs: ...` (no scope, as it is optional)
61+
* `<subject>`: A succinct description of the change, e.g., `add support for magic`
62+
* Use the imperative, present tense: "add", not "added" nor "adds"
63+
* Do not capitalize first letter: "add", not "Add"
64+
* No dot (.) at the end
65+
* `<body>`: Optional. Can include the motivation for the change and contrast this with previous behavior.
66+
* Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes"
67+
* `<footer>`: Optional. Can be used to automatically close GitHub Issues and to document breaking changes.
68+
* The prefix `BREAKING CHANGE: ` idicates API breakage (corresponding to a major version change) and everything after is a description what changed and what needs to be done to migrate
69+
* GitHub Issue controls such as `Fixes #123` or `Closes #4711` must come before a potential `BREAKING CHANGE: `.
70+
71+
Examples:
72+
```
73+
docs: improve how to contribute
74+
```
75+
```
76+
feat(core): add support for magic
77+
78+
Closes #110
79+
```
80+
```
81+
feat(core): add support for magic
82+
83+
Simplify the API by reducing the number of functions.
84+
85+
Closes #110
86+
BREAKING CHANGE: Change all calls to the API to the new `do()` function.
87+
```
88+
89+
## Pull Requests and Feature Branches
90+
91+
* Do not merge with master while developing a new feature or providing a fix in a new branch
92+
* Do a rebase if updates in the master such as a fix are required:
93+
```
94+
git checkout master && git pull && git checkout - && git rebase master
95+
```
96+
* Pull Requests are merged using rebase
97+
98+
## Contact
99+
100+
Contact the project developers via the project's "dev" list.
101+
102+
* https://dev.eclipse.org/mailman/listinfo/thingweb-dev

‎LICENSE.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Copyright (c) 2022 Contributors to the Eclipse Foundation
2+
3+
See the NOTICE file(s) distributed with this work for additional
4+
information regarding copyright ownership.
5+
6+
This program and the accompanying materials are made available under the
7+
terms of the Eclipse Public License v. 2.0 which is available at
8+
http://www.eclipse.org/legal/epl-2.0, or the W3C Software Notice and
9+
Document License (2015-05-13) which is available at
10+
https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document.
11+
12+
SPDX-License-Identifier: EPL-2.0 OR W3C-20150513

‎NOTICE.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Notices for Eclipse Thingweb
2+
3+
This content is produced and maintained by the Eclipse Thingweb project.
4+
5+
- Project home: https://projects.eclipse.org/projects/iot.thingweb
6+
7+
## Trademarks
8+
9+
Eclipse Thingweb is a trademark of the Eclipse Foundation.
10+
11+
## Copyright
12+
13+
All content is the property of the respective authors or their employers. For
14+
more information regarding authorship of content, please consult the listed
15+
source code repository logs.
16+
17+
Note: The {year} in the copyright statements is the year in which the content
18+
was created (e.g. “2004”). A range of years is not used.
19+
20+
## Declared Project Licenses
21+
22+
This program and the accompanying materials are made available under the terms
23+
of the Eclipse Public License v. 2.0 which is available at
24+
http://www.eclipse.org/legal/epl-2.0, or the W3C Software Notice and Document
25+
License (2015-05-13) which is available at
26+
https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document.
27+
28+
SPDX-License-Identifier: EPL-2.0 OR W3C-20150513
29+
30+
## Source Code
31+
32+
The project maintains the following source code repositories:
33+
34+
## Third-party Content
35+
36+
## Cryptography
37+
38+
Content may contain encryption software. The country in which you are currently
39+
may have restrictions on the import, possession, and use, and/or re-export to
40+
another country, of encryption software. BEFORE using any encryption software,
41+
please check the country's laws, regulations and policies concerning the import,
42+
possession, or use, and re-export of encryption software, to see if this is
43+
permitted.

‎README.md

+2-37
Original file line numberDiff line numberDiff line change
@@ -2,40 +2,5 @@
22

33
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
44

5-
### Installation
6-
7-
```
8-
$ yarn
9-
```
10-
11-
### Local Development
12-
13-
```
14-
$ yarn start
15-
```
16-
17-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18-
19-
### Build
20-
21-
```
22-
$ yarn build
23-
```
24-
25-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26-
27-
### Deployment
28-
29-
Using SSH:
30-
31-
```
32-
$ USE_SSH=true yarn deploy
33-
```
34-
35-
Not using SSH:
36-
37-
```
38-
$ GIT_USER=<Your GitHub username> yarn deploy
39-
```
40-
41-
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
5+
## Adopters
6+
If you are using any Eclipse Thingweb component within your organization, please support us by adding your logo to the [Eclipse IoT adopters list](https://iot.eclipse.org/adopters/#iot.thingweb). To do so, simply open an issue at [the Eclipse Gitlab](https://gitlab.eclipse.org/eclipsefdn/it/api/eclipsefdn-project-adopters/-/issues/new?issuable_template=adopter_request) by providing the name of your organization, its logo, and a link to your organization or team. You should be affiliated with that organization for the issue to be implemented.

‎SECURITY.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Notices for Eclipse Thingweb
2+
3+
This content is produced and maintained by the Eclipse Thingweb project.
4+
5+
- Project home: https://projects.eclipse.org/projects/iot.thingweb
6+
7+
## Trademarks
8+
9+
Eclipse Thingweb is a trademark of the Eclipse Foundation.
10+
11+
## Copyright
12+
13+
All content is the property of the respective authors or their employers. For
14+
more information regarding authorship of content, please consult the listed
15+
source code repository logs.
16+
17+
Note: The {year} in the copyright statements is the year in which the content
18+
was created (e.g. “2004”). A range of years is not used.
19+
20+
## Declared Project Licenses
21+
22+
This program and the accompanying materials are made available under the terms
23+
of the Eclipse Public License v. 2.0 which is available at
24+
http://www.eclipse.org/legal/epl-2.0, or the W3C Software Notice and Document
25+
License (2015-05-13) which is available at
26+
https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document.
27+
28+
SPDX-License-Identifier: EPL-2.0 OR W3C-20150513
29+
30+
## Source Code
31+
32+
The project maintains the following source code repositories:
33+
34+
## Third-party Content
35+
36+
## Cryptography
37+
38+
Content may contain encryption software. The country in which you are currently
39+
may have restrictions on the import, possession, and use, and/or re-export to
40+
another country, of encryption software. BEFORE using any encryption software,
41+
please check the country's laws, regulations and policies concerning the import,
42+
possession, or use, and re-export of encryption software, to see if this is
43+
permitted.

0 commit comments

Comments
 (0)