From ce2573b32c03e7b66e13e678b657ebfcf3f8b9fc Mon Sep 17 00:00:00 2001 From: Jan Romann Date: Fri, 17 May 2024 16:02:33 +0200 Subject: [PATCH 1/3] docs: create CONTRIBUTING.md file --- CONTRIBUTING.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..9a70c2c8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,40 @@ +# 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/node-wot/pulls) + +For more information, please see the Eclipse Committer Handbook: +https://www.eclipse.org/projects/handbook/#resources-commit + +## Contact + +Contact the project developers via the project's "dev" list. + +- https://dev.eclipse.org/mailman/listinfo/thingweb-dev From 22658205e188548a67cf5d966679f91b05276d10 Mon Sep 17 00:00:00 2001 From: Jan Romann Date: Fri, 17 May 2024 16:14:09 +0200 Subject: [PATCH 2/3] docs(README.md): add reference to CONTRIBUTING.md --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 1c40bd46..41cb5d2d 100644 --- a/README.md +++ b/README.md @@ -124,9 +124,7 @@ implementation for the Node.js ecosystem. ## Contribution -Unless you explicitly state otherwise, any contribution intentionally submitted -for inclusion in the work by you, shall be licensed as above, without any additional -terms or conditions. +Please refer to our [contribution guidelines](CONTRIBUTING.md) for more details. ## Maintainers From 5e0cb1b8b4bf6c6445a9d89954934c9d363bff1c Mon Sep 17 00:00:00 2001 From: Jan Romann Date: Fri, 17 May 2024 16:14:45 +0200 Subject: [PATCH 3/3] docs(README.md): remove obsolete contribution guidelines --- README.md | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/README.md b/README.md index 41cb5d2d..05436ba3 100644 --- a/README.md +++ b/README.md @@ -94,21 +94,6 @@ Future main(List args) async { More complex examples can be found in the `example` directory. -## Additional information - -The package will be extended gradually over the upcoming months. -Support for exposing Things will be added as well as -more protocols and security schemes. - -Contributions are very welcome. -You will soon be able to find guidelines for contributing to the package -in a `CONTRIBUTING` file. -Until then, you can already file issues for pointing out bugs or requesting -features. -You can also open PRs; these have to adhere the defined coding style and -linter rules. -Contributions will be licensed according to the project licenses (see below). - ## License `dart_wot` is licensed under the 3-Clause BSD License.