-
Notifications
You must be signed in to change notification settings - Fork 13
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[403] Integrate the parts of the wiki that are still relevant #458
Open
pcdavid
wants to merge
7
commits into
master
Choose a base branch
from
pcd/doc/wiki
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+4,193
−46
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
adc4d18
[doc] Add CODE_OF_CONDUCT.md
pcdavid c9f146a
[doc] Update NOTICE file
pcdavid abb1d4e
[releng] Set the default target platform to 2023-03
pcdavid 98c17a2
[doc] Update the README
pcdavid 5c03890
[403] Add a copy of the existing EF wiki pages
pcdavid c9f090b
[403] Update and complete the CONTRIBUTING file
pcdavid ebf7310
[403] Add a new FAQ page with the old FAQ & cookbook wiki pages content
pcdavid File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
# Community Code of Conduct | ||
|
||
Project obeys latest version of the Eclipse Community Code of Conduct, available at https://www.eclipse.org/org/documents/Community_Code_of_Conduct.php | ||
|
||
Here is a copy of current version as this document was created: | ||
|
||
**Version 2.0 | ||
January 1, 2023** | ||
|
||
## Our Pledge | ||
|
||
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. | ||
|
||
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. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contribute to creating a positive and professional environment include: | ||
|
||
- Using welcoming and inclusive language; | ||
- Actively encouraging all voices; | ||
- 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; | ||
- 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; | ||
- Being direct but professional; and | ||
- Leading by example by holding yourself and others accountable | ||
|
||
Examples of unacceptable behavior by Contributors include: | ||
|
||
- The use of sexualized language or imagery; | ||
- Unwelcome sexual attention or advances; | ||
- Trolling, insulting/derogatory comments, and personal or political attacks; | ||
- Public or private harassment, repeated harassment; | ||
- Publishing others' private information, such as a physical or electronic address, without explicit permission; | ||
- Violent threats or language directed against another person; | ||
- Sexist, racist, or otherwise discriminatory jokes and language; | ||
- Posting sexually explicit or violent material; | ||
- Sharing private content, such as emails sent privately or non-publicly, or unlogged forums such as IRC channel history; | ||
- Personal insults, especially those using racist or sexist terms; | ||
- Excessive or unnecessary profanity; | ||
- Advocating for, or encouraging, any of the above behavior; and | ||
- Other conduct which could reasonably be considered inappropriate in a professional setting | ||
|
||
## Our Responsibilities | ||
|
||
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. | ||
|
||
## Scope | ||
|
||
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. | ||
|
||
## Enforcement | ||
|
||
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. | ||
|
||
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. | ||
|
||
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. | ||
|
||
## Responsibility | ||
|
||
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]>. | ||
|
||
## Investigation of Potential Code Violations | ||
|
||
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. | ||
|
||
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. | ||
|
||
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. | ||
|
||
## Actions | ||
Contributors who do not follow this Code in good faith may face temporary or permanent repercussions as determined by the Conduct Committee. | ||
|
||
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. | ||
|
||
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. | ||
|
||
## No Retaliation | ||
|
||
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. | ||
|
||
False reporting, especially when intended to retaliate or exclude, is itself a violation of this Code and will not be accepted or tolerated. | ||
|
||
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]>. | ||
|
||
## Amendments | ||
|
||
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. | ||
|
||
### Attribution | ||
|
||
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/). | ||
|
||
[^1]: Capitalized terms used herein without definition shall have the meanings assigned to them in the Bylaws. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# Contributing to Sirius | ||
# Contributing to Sirius Desktop | ||
|
||
Thanks for your interest in this project. | ||
|
||
|
@@ -8,9 +8,11 @@ Eclipse Sirius enables the specification of a modeling workbench in terms of | |
graphical, table or tree editors with validation rules and actions using | ||
declarative descriptions. | ||
|
||
* https://www.eclipse.dev/sirius | ||
* https://eclipse.dev/sirius | ||
* https://projects.eclipse.org/projects/modeling.sirius | ||
* https://wiki.eclipse.org/Sirius | ||
|
||
This document focuses on Sirius Desktop, which is based on the Eclipse platform. | ||
For information about Sirius Web, see https://github.com/eclipse-sirius/sirius-web instead. | ||
|
||
## Developer resources | ||
|
||
|
@@ -19,29 +21,91 @@ more. | |
|
||
* https://projects.eclipse.org/projects/modeling.sirius/developer | ||
|
||
The project maintains the following source code repositories | ||
The official source code for Sirius Desktop is at: | ||
|
||
* https://github.com/eclipse-sirius/sirius-desktop.git | ||
* https://github.com/eclipse-sirius/sirius-desktop | ||
|
||
This project uses Bugzilla to track ongoing development and issues. | ||
This project uses GitHub to track ongoing development and issues. | ||
|
||
* Search for issues: https://eclipse.org/bugs/buglist.cgi?product=Sirius | ||
* Create a new report: https://eclipse.org/bugs/enter_bug.cgi?product=Sirius | ||
* Search for issues: https://github.com/eclipse-sirius/sirius-desktop/issues | ||
* Create a new issue: https://github.com/eclipse-sirius/sirius-desktop/issues/new/choose | ||
|
||
Be sure to search for existing bugs before you create another one. | ||
Remember that contributions are always welcome! There are many ways to | ||
contribute, from entering high quality bug reports, to contributing | ||
code or documentation changes. For a complete guide, see the [How to | ||
Contribute](http://wiki.eclipse.org/Sirius/Contributor_Guide) page on | ||
the team wiki. For further questions about contributing to Sirius, | ||
please send a mail to [email protected]. | ||
code or documentation changes. | ||
|
||
## Development Environment | ||
|
||
The standard environment to develop Sirius Desktop itself is currently: | ||
|
||
* _Java 17_. Mandatory since Eclipse 2023-09 and Sirius Desktop 7.2.0. | ||
* _Maven 3.9_ to build. | ||
* _Eclipse 2023-03_ is the reference target platform and the oldest supported version. For the actual development environment, it is recommended to use the most recent Eclipse release to benefit from the latest features and improvements. | ||
* You will need the _EMF SDK_ installed in your IDE. If you use the _Eclipse Modeling Tools_ [package](https://www.eclipse.org/downloads/packages/) or [_Obeo Designer_](https://www.obeodesigner.com/), this come pre-installed. If you use another package (for example _Eclipse for Committers_) you will need to install it explicitly. | ||
* Also make sure you have _Eclipse CheckStyle Plug-in 10.4_ installed from [here](https://checkstyle.org/eclipse-cs-update-site/releases/10.4.0.202211151918): required to make sure new code follows the CheckStyle-enforced rules, which are defined in [`releng/org.eclipse.sirius.settings/CheckstyleConfiguration.xml`](https://github.com/eclipse-sirius/sirius-desktop/blob/master/releng/org.eclipse.sirius.settings/CheckstyleConfiguration.xml). | ||
|
||
Of course you are free to use any additional tools you want to make your development experience more pleasant for you. | ||
However, do not commit anything which adds new requirements without getting approval from the development team. | ||
|
||
## Getting the sources | ||
|
||
1. Clone the source code for Sirius Desktop from <https://github.com/eclipse-sirius/sirius-desktop>. | ||
2. Import all the Eclipse projects inside the clone in you Eclipse workspace. | ||
3. Load one of the target platforms available in the `org.eclipse.sirius.targets` project to set it as the current target. | ||
|
||
## Git and GitHub Usage | ||
|
||
Development is done on the `master`, but all but the most trivial patches must first go through a pull request and review. | ||
|
||
Obviously, each contributor is free to do whatever he/she wants on his/her local clone(s), the rules above only apply to commits and branches pushed into the official repository. | ||
|
||
## Commit Messages Formatting | ||
|
||
All commit messages *must* follow the following pattern: | ||
|
||
``` | ||
[ISSUE_ID] Short description | ||
|
||
Longer description if needed, explaining the reasons of the change and its | ||
impact, not paraphrasing the patch. The description should use wrapped line. | ||
|
||
Bug: https://github.com/eclipse-sirius/sirius-desktop/issues/ISSUE_ID | ||
Signed-off-by: author name | ||
``` | ||
|
||
* Always mention the numeric bug id at the start of the first line (e.g. `[432]`). For the few cases where a commit is not directly related to a bugzilla, use a tag like `[build]`, `[version]`, `[cleanup]`... See the history for the list of acceptable tags. | ||
* The first line should be _short_, this is not the place to give details. | ||
* It should describe what the commit does, not reproduce the issue title. Not "Error when a drag&drop involves updating the content of this element" but "Disable refresh for removed children in CanonicalSynchronizer". | ||
* It should be written in imperative form, i.e. "Improve the color palette DnD feedback", not "Improved the color palette DnD feedback". | ||
* The `Bug: https://github.com/eclipse-sirius/sirius-desktop/issues/432` footer line is should include the full URL to the issue, not just its number (this avoids ambiguity with older bugzilla issues). | ||
* The `Signed-of-by:` is mandatory. | ||
|
||
## Documentation Updates | ||
|
||
All the documentation is inside the `org.eclipse.sirius.doc` plugin, inside the `doc` directory. | ||
This is what gets deployed at https://eclipse.dev/sirius/doc on each new release. | ||
|
||
The source files for the documentation are currently written in [Textile](https://textile-lang.com/), though this will change in the future for AsciiDoc. | ||
To edit Textile files conveniently inside Eclipse you can install [Mylyn WikiText](https://marketplace.eclipse.org/content/mylyn-wikitext). | ||
|
||
All commits that change the behavior of the system in a visible way should be mentioned in the `Release Notes.textile` in the section corresponding to the version the change will appear. | ||
This includes API changes/breaks that adopters need to be aware of when upgrading to that version. | ||
|
||
Non trivial changes must also be documented in the actual manual, either: | ||
* in the _developer_ section for important new APIs and extension points; | ||
* in the _specifier_ section for changes that concern the way Sirius modeler are specified (the `odesign` files); | ||
* on in the _user_ section for changes visible to end-users of Sirius-based modelers. | ||
|
||
Commits that change the documentation sources (`*.textile`) *must* also include the corresponding updated HTML files (and any new images referenced of course). | ||
To re-generated the HTML files from the Textile sources, invoke the _Sirius - Generate HTML Documentation_ launch configuration. | ||
|
||
## Eclipse Contributor Agreement | ||
|
||
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 | ||
* https://www.eclipse.org/legal/ECA.php | ||
|
||
Commits that are provided by non-committers must have a Signed-off-by field in | ||
the footer indicating that the author is aware of the terms by which the | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.