Skip to content

Commit a17e292

Browse files
0.0.1 release preparations (#5)
* 0.0.1 release preparations Signed-off-by: Jens Reinecke <[email protected]> * Update README.md Co-authored-by: Philip Langer <[email protected]> --------- Signed-off-by: Jens Reinecke <[email protected]> Co-authored-by: Philip Langer <[email protected]>
1 parent 5e425b1 commit a17e292

File tree

4 files changed

+181
-1
lines changed

4 files changed

+181
-1
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Change Log
2+
3+
## 0.0.1
4+
- Initial release of this package.
5+
- Adds [Tree](./src/tree/README.md) component.

CODE_OF_CONDUCT.md

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# Community Code of Conduct
2+
3+
**Version 2.0
4+
January 1, 2023**
5+
6+
## Our Pledge
7+
8+
In the interest of fostering an open and welcoming environment, we as community members, contributors, Committers[^1], and Project Leads (collectively "Contributors") pledge to make participation in our projects and our community a harassment-free and inclusive experience for everyone.
9+
10+
This Community Code of Conduct ("Code") outlines our behavior expectations as members of our community in all Eclipse Foundation activities, both offline and online. It is not intended to govern scenarios or behaviors outside of the scope of Eclipse Foundation activities. Nor is it intended to replace or supersede the protections offered to all our community members under the law. Please follow both the spirit and letter of this Code and encourage other Contributors to follow these principles into our work. Failure to read or acknowledge this Code does not excuse a Contributor from compliance with the Code.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contribute to creating a positive and professional environment include:
15+
16+
- Using welcoming and inclusive language;
17+
- Actively encouraging all voices;
18+
- Helping others bring their perspectives and listening actively. If you find yourself dominating a discussion, it is especially important to encourage other voices to join in;
19+
- Being respectful of differing viewpoints and experiences;
20+
- Gracefully accepting constructive criticism;
21+
- Focusing on what is best for the community;
22+
- Showing empathy towards other community members;
23+
- Being direct but professional; and
24+
- Leading by example by holding yourself and others accountable
25+
26+
Examples of unacceptable behavior by Contributors include:
27+
28+
- The use of sexualized language or imagery;
29+
- Unwelcome sexual attention or advances;
30+
- Trolling, insulting/derogatory comments, and personal or political attacks;
31+
- Public or private harassment, repeated harassment;
32+
- Publishing others' private information, such as a physical or electronic address, without explicit permission;
33+
- Violent threats or language directed against another person;
34+
- Sexist, racist, or otherwise discriminatory jokes and language;
35+
- Posting sexually explicit or violent material;
36+
- Sharing private content, such as emails sent privately or non-publicly, or unlogged forums such as IRC channel history;
37+
- Personal insults, especially those using racist or sexist terms;
38+
- Excessive or unnecessary profanity;
39+
- Advocating for, or encouraging, any of the above behavior; and
40+
- Other conduct which could reasonably be considered inappropriate in a professional setting
41+
42+
## Our Responsibilities
43+
44+
With the support of the Eclipse Foundation employees, consultants, officers, and directors (collectively, the "Staff"), Committers, and Project Leads, the Eclipse Foundation Conduct Committee (the "Conduct Committee") is responsible for clarifying the standards of acceptable behavior. The Conduct Committee takes appropriate and fair corrective action in response to any instances of unacceptable behavior.
45+
46+
## Scope
47+
48+
This Code applies within all Project, Working Group, and Interest Group spaces and communication channels of the Eclipse Foundation (collectively, "Eclipse spaces"), within any Eclipse-organized event or meeting, and in public spaces when an individual is representing an Eclipse Foundation Project, Working Group, Interest Group, or their communities. Examples of representing a Project or community include posting via an official social media account, personal accounts, or acting as an appointed representative at an online or offline event. Representation of Projects, Working Groups, and Interest Groups may be further defined and clarified by Committers, Project Leads, or the Staff.
49+
50+
## Enforcement
51+
52+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the Conduct Committee via [email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. Without the explicit consent of the reporter, the Conduct Committee is obligated to maintain confidentiality with regard to the reporter of an incident. The Conduct Committee is further obligated to ensure that the respondent is provided with sufficient information about the complaint to reply. If such details cannot be provided while maintaining confidentiality, the Conduct Committee will take the respondent‘s inability to provide a defense into account in its deliberations and decisions. Further details of enforcement guidelines may be posted separately.
53+
54+
Staff, Committers and Project Leads have the right to report, remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code, or to block temporarily or permanently any Contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. Any such actions will be reported to the Conduct Committee for transparency and record keeping.
55+
56+
Any Staff (including officers and directors of the Eclipse Foundation), Committers, Project Leads, or Conduct Committee members who are the subject of a complaint to the Conduct Committee will be recused from the process of resolving any such complaint.
57+
58+
## Responsibility
59+
60+
The responsibility for administering this Code rests with the Conduct Committee, with oversight by the Executive Director and the Board of Directors. For additional information on the Conduct Committee and its process, please write to <[email protected]>.
61+
62+
## Investigation of Potential Code Violations
63+
64+
All conflict is not bad as a healthy debate may sometimes be necessary to push us to do our best. It is, however, unacceptable to be disrespectful or offensive, or violate this Code. If you see someone engaging in objectionable behavior violating this Code, we encourage you to address the behavior directly with those involved. If for some reason, you are unable to resolve the matter or feel uncomfortable doing so, or if the behavior is threatening or harassing, please report it following the procedure laid out below.
65+
66+
Reports should be directed to <[email protected]>. It is the Conduct Committee’s role to receive and address reported violations of this Code and to ensure a fair and speedy resolution.
67+
68+
The Eclipse Foundation takes all reports of potential Code violations seriously and is committed to confidentiality and a full investigation of all allegations. The identity of the reporter will be omitted from the details of the report supplied to the accused. Contributors who are being investigated for a potential Code violation will have an opportunity to be heard prior to any final determination. Those found to have violated the Code can seek reconsideration of the violation and disciplinary action decisions. Every effort will be made to have all matters disposed of within 60 days of the receipt of the complaint.
69+
70+
## Actions
71+
Contributors who do not follow this Code in good faith may face temporary or permanent repercussions as determined by the Conduct Committee.
72+
73+
This Code does not address all conduct. It works in conjunction with our [Communication Channel Guidelines](https://www.eclipse.org/org/documents/communication-channel-guidelines/), [Social Media Guidelines](https://www.eclipse.org/org/documents/social_media_guidelines.php), [Bylaws](https://www.eclipse.org/org/documents/eclipse-foundation-be-bylaws-en.pdf), and [Internal Rules](https://www.eclipse.org/org/documents/ef-be-internal-rules.pdf) which set out additional protections for, and obligations of, all contributors. The Foundation has additional policies that provide further guidance on other matters.
74+
75+
It’s impossible to spell out every possible scenario that might be deemed a violation of this Code. Instead, we rely on one another’s good judgment to uphold a high standard of integrity within all Eclipse Spaces. Sometimes, identifying the right thing to do isn’t an easy call. In such a scenario, raise the issue as early as possible.
76+
77+
## No Retaliation
78+
79+
The Eclipse community relies upon and values the help of Contributors who identify potential problems that may need to be addressed within an Eclipse Space. Any retaliation against a Contributor who raises an issue honestly is a violation of this Code. That a Contributor has raised a concern honestly or participated in an investigation, cannot be the basis for any adverse action, including threats, harassment, or discrimination. If you work with someone who has raised a concern or provided information in an investigation, you should continue to treat the person with courtesy and respect. If you believe someone has retaliated against you, report the matter as described by this Code. Honest reporting does not mean that you have to be right when you raise a concern; you just have to believe that the information you are providing is accurate.
80+
81+
False reporting, especially when intended to retaliate or exclude, is itself a violation of this Code and will not be accepted or tolerated.
82+
83+
Everyone is encouraged to ask questions about this Code. Your feedback is welcome, and you will get a response within three business days. Write to <[email protected]>.
84+
85+
## Amendments
86+
87+
The Eclipse Foundation Board of Directors may amend this Code from time to time and may vary the procedures it sets out where appropriate in a particular case.
88+
89+
### Attribution
90+
91+
This Code was inspired by the [Contributor Covenant](https://www.contributor-covenant.org/), version 1.4, available [here](https://www.contributor-covenant.org/version/1/4/code-of-conduct/).
92+
93+
[^1]: Capitalized terms used herein without definition shall have the meanings assigned to them in the Bylaws.

CONTRIBUTING.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Contributing to Eclipse CDT UI Components for Visual Studio Code Extensions
2+
3+
This repository is the home to the Eclipse CDT UI Components for Visual Studio Code Extensions.
4+
5+
## How Can I Contribute?
6+
7+
In the following some of the typical ways of contribution are described.
8+
9+
### Asking Questions
10+
11+
It's totally fine to ask questions by opening an issue in the
12+
[GitHub repository](https://github.com/eclipse-cdt-cloud/vscode-ui-components).
13+
We will close it once it's answered and tag it with the 'question' label.
14+
Please check if the question has been asked before.
15+
16+
### Reporting Bugs
17+
18+
If you have found a bug, you should first check if it has already been filed
19+
and maybe even fixed in the
20+
[issues](https://github.com/eclipse-cdt-cloud/vscode-ui-components/issues).
21+
If you find an existing unresolved issue, please add your case. If you could not
22+
find an existing bug report, please
23+
[file a new one](https://github.com/eclipse-cdt-cloud/vscode-ui-components/issues/new/choose).
24+
In any case, please add all information you can share and that will help to
25+
reproduce and solve the problem.
26+
27+
### Reporting Feature Requests
28+
29+
You may want to see a feature or have an idea. You can
30+
[file a request](https://github.com/eclipse-cdt-cloud/vscode-ui-components/issues/new/choose)
31+
and we can discuss it. If such a feature request already exists, please add a comment
32+
or some other form of feedback to indicate you are interested, too. Also in this
33+
case any concrete use case scenario is appreciated to understand the motivation
34+
behind it.
35+
36+
### Pull Requests
37+
38+
Before you get started investing significant time in something you want to get
39+
merged and maintained as part of this project, you should talk with the team
40+
by posting on an issue. Simply choose the issue you would want to work on, and tell everyone
41+
that you are willing to do so and how you would approach it. The team will be
42+
happy to guide you and give feedback.
43+
44+
## Eclipse Contributor Agreement
45+
46+
Before your contribution can be accepted by the project team contributors must
47+
electronically sign the Eclipse Contributor Agreement (ECA).
48+
49+
* http://www.eclipse.org/legal/ECA.php
50+
51+
Commits that are provided by non-committers must have a Signed-off-by field in
52+
the footer indicating that the author is aware of the terms by which the
53+
contribution has been provided to the project. The non-committer must
54+
additionally have an Eclipse Foundation account and must have a signed Eclipse
55+
Contributor Agreement (ECA) on file.
56+
57+
For more information, please see the Eclipse Committer Handbook:
58+
https://www.eclipse.org/projects/handbook/#resources-commit
59+
60+
## Sign your work
61+
62+
The sign-off is a simple line at the end of the explanation for the patch. Your
63+
signature certifies that you wrote the patch or otherwise have the right to
64+
pass it on as an open-source patch.
65+
66+
Signed-off-by: Joe Smith <[email protected]>
67+
68+
Use your real name (sorry, no pseudonyms or anonymous contributions.)
69+
70+
If you set your `user.name` and `user.email` git configs, you can sign your
71+
commit automatically with `git commit -s`.

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# UI Components for Visual Studio Code Extensions
22

3-
This is a VS Code components React library.
3+
This is a UI component library for developing WebViews in Visual Studio Code extensions.
44

55
## Project Structure
66

@@ -27,3 +27,14 @@ src/
2727
- [Tree](./src/tree/README.md): A component that combines tree structure functionality with table capabilities.
2828

2929
For usage information, refer to the component's README.
30+
31+
## Contributing
32+
33+
We welcome contributions on [GitHub](https://github.com/eclipse-cdt-cloud/vscode-ui-components).
34+
Check our [contribution guidelines](./CONTRIBUTING.md) for more info.
35+
This open-source project is part of [Eclipse CDT Cloud](https://eclipse.dev/cdt-cloud/).
36+
37+
## Trademarks
38+
39+
Visual Studio Code, VS Code, and the Visual Studio Code icon are trademarks of Microsoft Corporation. All rights reserved.<br>
40+
Eclipse, CDT, and CDT.cloud are trademarks of Eclipse Foundation, Inc.<br>

0 commit comments

Comments
 (0)