-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(CONTRIBUTING): replace content with reference
- Loading branch information
1 parent
08fe51b
commit 053d8c2
Showing
1 changed file
with
2 additions
and
259 deletions.
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 |
|---|---|---|
| @@ -1,261 +1,4 @@ | ||
| # Contributing to the Project | ||
|
|
||
| Thank you for your interest in contributing to | ||
| the [Eclipse Dataspace Components](https://projects.eclipse.org/projects/technology.edc)! | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| * [Code Of Conduct](#code-of-conduct) | ||
| * [Eclipse Contributor Agreement](#eclipse-contributor-agreement) | ||
| * [How to Contribute](#how-to-contribute) | ||
| * [Discuss](#discuss) | ||
| * [Create an Issue](#create-an-issue) | ||
| * [Submit a Pull Request](#submit-a-pull-request) | ||
| * [Report on Flaky Tests](#report-on-flaky-tests) | ||
| * [Project and Milestone Planning](#project-and-milestone-planning) | ||
| * [Milestones](#milestones) | ||
| * [Projects](#projects) | ||
| * [Releases](#releases) | ||
| * [Contact Us](#contact-us) | ||
|
|
||
| ## Code Of Conduct | ||
|
|
||
| See the [Eclipse Code Of Conduct](https://www.eclipse.org/org/documents/Community_Code_of_Conduct.php). | ||
|
|
||
| ## Eclipse Contributor Agreement | ||
|
|
||
| Before your contribution can be accepted by the project, you need to create and electronically sign | ||
| a [Eclipse Contributor Agreement (ECA)](http://www.eclipse.org/legal/ecafaq.php): | ||
|
|
||
| 1. Log in to the [Eclipse foundation website](https://accounts.eclipse.org/user/login/). You will | ||
| need to create an account within the Eclipse Foundation if you have not already done so. | ||
| 2. Click on "Eclipse ECA", and complete the form. | ||
|
|
||
| Be sure to use the same email address in your Eclipse Account that you intend to use when you commit | ||
| to GitHub. | ||
|
|
||
| ## How to Contribute | ||
|
|
||
| ### Discuss | ||
|
|
||
| If you want to share an idea to further enhance | ||
| the project or discuss potential use cases, please feel free to create a discussion. | ||
| - For detailed and repository-specific topics, use the [GitHub discussions](https://github.com/features/discussions) | ||
| in a repository. | ||
| - For high-level and general questions or discussions (e.g., relations to Gaia-X, plannings), or if you | ||
| want to share use case related ideas or receive feedback from the community, please use the [GitHub | ||
| organization's discussions](https://github.com/orgs/eclipse-edc/discussions). | ||
|
|
||
| If you feel there is a bug or an issue, contribute to the discussions in **existing issues**, otherwise | ||
| [create a new issue](#create-an-issue). | ||
|
|
||
| ### Create an Issue | ||
|
|
||
| If you have identified a bug or want to formulate a working item that you want to concentrate on, | ||
| feel free to create a new issue at the repository's corresponding GitHub Issues page. | ||
|
|
||
| Before doing so, please consider searching for potentially suitable existing issues: https://github.com/eclipse-edc/.../issues?q=is%3Aissue+is%3Aopen. | ||
|
|
||
| We also use [GitHub's default label set](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels) | ||
| extended by custom ones to classify issues and improve findability. | ||
|
|
||
| If an issue appears to cover changes that will have a (huge) impact on the code base and needs to | ||
| first be discussed, or if you just have a question regarding the usage of the software, please | ||
| create a discussion before raising an issue. | ||
|
|
||
| Please note that if an issue covers a topic or the response to a question that may be interesting | ||
| for other developers or contributors, or for further discussions, it should be converted to a | ||
| discussion and not be closed. | ||
|
|
||
| ### Adhere to Coding Style Guide | ||
|
|
||
| We aim for a coherent and consistent code base, thus the coding style detailed in the | ||
| [styleguide](contributing/styleguide.md) should be followed. | ||
|
|
||
| ### Submit a Pull Request | ||
|
|
||
| In addition to the contribution guideline made available in the | ||
| [Eclipse project handbook](https://www.eclipse.org/projects/handbook/#contributing), | ||
| we would appreciate if your pull request applies to the following points: | ||
|
|
||
| * Conform to [Pull-Request Etiquette](contributing/pr_etiquette.md) | ||
|
|
||
| * Always apply the following copyright header to specific files in your work replacing the fields | ||
| enclosed by curly brackets "{}" with your own identifying information. (Don't include the curly | ||
| brackets!) Enclose the text in the appropriate comment syntax for the file format. | ||
|
|
||
| ```text | ||
| Copyright (c) {year} {owner}[ and others] | ||
| This program and the accompanying materials are made available under the | ||
| terms of the Apache License, Version 2.0 which is available at | ||
| https://www.apache.org/licenses/LICENSE-2.0 | ||
| SPDX-License-Identifier: Apache-2.0 | ||
| Contributors: | ||
| {name} - {description} | ||
| ``` | ||
| * The git commit messages should comply to the following format: | ||
| ``` | ||
| <prefix>(<scope>): <description> | ||
| ``` | ||
| Use the [imperative mood](https://github.com/git/git/blob/master/Documentation/SubmittingPatches) | ||
| as in "Fix bug" or "Add feature" rather than "Fixed bug" or "Added feature" and | ||
| [mention the GitHub issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) | ||
| e.g. `chore(transfer process): improve logging`. | ||
| All committers and all commits, are bound to | ||
| the [Developer Certificate of Origin.](https://www.eclipse.org/legal/DCO.php) | ||
| As such, all parties involved in a contribution must have valid ECAs. Additionally, commits can | ||
| include a ["Signed-off-by" entry](https://wiki.eclipse.org/Development_Resources/Contributing_via_Git). | ||
| * Add meaningful tests to verify your submission acts as expected. | ||
| * Where code is not self-explanatory, add documentation providing extra clarification. | ||
| * Add documentation files to new modules. See [here](#add-documentation) for more details. | ||
| * If a new module has been added or a significant part of the code has been changed, and you should | ||
| or want to be seen as the contact person for any further changes, please add appropriate | ||
| information to the [CODEOWNERS](https://github.com/eclipse-edc/Connector/blob/main/CODEOWNERS) | ||
| file. You can find instructions on how to do this at <https://help.github.com/articles/about-codeowners/>. | ||
| Please note that this file does not represent all contributions to the code. What persons and organizations | ||
| actually contributed to each file can be seen on GitHub and is documented in the license headers. | ||
| * PR descriptions should use the current [PR template](.github/PULL_REQUEST_TEMPLATE.md) | ||
| * Submit a draft pull request at early-stage and add people previously working on the same code as | ||
| reviewer. Make sure automatic checks pass before marking it as "ready for review": | ||
| * _Intellectual Property Validation_ verifying the [Eclipse CLA](#eclipse-contributor-agreement) | ||
| has been signed as well as commits have been signed-off and | ||
| * _Continuous Integration_ performing various test conventions. | ||
| ### Stale issues and PRs | ||
| In order to keep our backlog clean we are using a bot that helps us label and eventually close old issues and PRs. The | ||
| following table shows the particular timings. | ||
| | | `stale` after | closed after days `stale` | | ||
| |------------------------|---------------|---------------------------| | ||
| | Issue without assignee | 14 | 7 | | ||
| | Issue with assignee | 28 | 7 | | ||
| | PR | 7 | 7 | | ||
| Note that updating an issue, e.g. by commenting, will remove the `stale` label again and reset the counters. However, | ||
| we ask the community **not to abuse** this feature (e.g. commenting "what's the status?" every X days would certainly | ||
| be qualified as abuse). If an issue receives no attention, there usually | ||
| are reasons for it. It is therefore advisable to clarify in advance whether any particular feature fits into EDC's | ||
| planning schedule and roadmap. For that, we recommend opening a discussion. Discussions serve us as a system of record, that | ||
| means we monitor them more closely, and do not close them automatically. | ||
| ### Add Documentation | ||
| Every decision record, launcher, extension, or any type of module has to provide documentation that covers at least | ||
| one markdown file with necessary information. Please find appropriate templates that should | ||
| be used in [the templates directory](docs/templates). | ||
| ### Report on Flaky Tests | ||
| If you discover a randomly failing ("flaky") test, please take the time to check whether an issue for that already | ||
| exists and if not, create an issue yourself, providing meaningful description and a link to the failing run. Please also | ||
| label it with `Bug` and `FlakyTest`. Then assign it to whoever was the original author of the relevant piece of code or | ||
| whoever worked on it last. If assigning the issue is not possible due to missing rights, please just comment and | ||
| @mention the author/last editor. | ||
| Please do not just restart the run, as this would overwrite the results. If you need to, a better way of doing this is | ||
| to push an empty commit. This will trigger another run. | ||
| ```bash | ||
| git commit --allow-empty -m "trigger CI" && git push | ||
| ``` | ||
|
|
||
| If an issue labeled with `Bug` and `FlakyTest` is assigned to you, please prioritize addressing this issue as other people will be affected. | ||
| We are taking the quality of our code very serious and reporting on flaky tests is an important step toward improvement | ||
| in that area. | ||
|
|
||
| ## Non-code Contributions | ||
|
|
||
| The following list shows examples of non-code contributions which, however, are not limited to: | ||
|
|
||
| - Strengthen the EDC brand | ||
| - Evangelizing the project | ||
| - Developing community | ||
| - Community education | ||
| - Answering questions on GitHub, Discord, Youtube, etc. | ||
| - Onboarding new contributors | ||
| - Contribute to EDC docs | ||
| - Doing hands-on sessions and demos | ||
| - Outward-facing community work | ||
| - Hosting meetups (Q&A) and general evangelism | ||
| - Presentation of work to meetups | ||
| - Social Media | ||
| - Non-Documentation writing (Blogs, Articles, Interviews) | ||
| - Branding/Visual Communication | ||
| - Website management | ||
| - Visuals (diagrams, infographic design, icon design) | ||
| - Management of communication tools (at the discretion of project maintainers) | ||
| - Mailing list moderation | ||
| - Discord management | ||
| - Calendar management | ||
| - Event management | ||
| - Host community events | ||
| - Support summits and hackathons | ||
| - Staffing EDC booths at conferences | ||
|
|
||
| ## Project and Milestone Planning | ||
|
|
||
| We use milestones to set a common focus for a period of 6 to 8 weeks. | ||
| The group of committers chooses issues based on customer needs and contributions we expect. | ||
|
|
||
| ### Milestones | ||
|
|
||
| Milestones are organized at the [GitHub Milestones page](https://github.com/eclipse-edc/Connector/milestones). | ||
| They are numbered in ascending order. There, contributors, users, and adopters can track the progress. | ||
|
|
||
| Please note that the due date of a milestone does not imply any guarantee that all linked issued will | ||
| be resolved by then. | ||
|
|
||
| When closing the current milestone, issues that were not resolved within a milestone phase will be | ||
| reviewed to evaluate their relevance and priority, before being assigned to the next milestone. | ||
|
|
||
| #### Issues | ||
|
|
||
| Every issue that should be addressed during a milestone phase is assigned to it by using the | ||
| `Milestone` feature for linking both items. This way, the issues can easily be filtered by | ||
| milestones. | ||
|
|
||
| #### Pull Requests | ||
|
|
||
| Pull requests are not assigned to milestones as their linking to issues is sufficient to track | ||
| the relations and progresses. | ||
|
|
||
| ### Projects | ||
|
|
||
| The [GitHub Projects page](https://github.com/eclipse-edc/Connector/projects) | ||
| provides a general overview of the project's working items. Every new issue is automatically assigned | ||
| to the ["Dataspace Connector" project](https://github.com/orgs/eclipse-edc/projects/3). | ||
| It can be unassigned or moved to any other project that is provided. | ||
|
|
||
| In every project, an issue passes four stages: `Backlog`, `In progress`, `Review in progress`, and `Done`, | ||
| independent of their association to a specific milestone. | ||
|
|
||
| ### Releases | ||
|
|
||
| Please find more information about our release approach [here](docs/developer/releases.md). | ||
|
|
||
| ## Contact Us | ||
|
|
||
| If you have questions or suggestions, do not hesitate to contact the project developers via | ||
| the [project's "dev" list](https://dev.eclipse.org/mailman/listinfo/edc-dev). | ||
|
|
||
| You may also want to join our [Discord server](https://discord.gg/n4sD9qtjMQ). | ||
|
|
||
| There, we provide a biweekly meeting on fridays 2-3 p.m. (CET) to give any interested person the | ||
| opportunity to get in touch with the committer team. We are meeting in the "general" voice channel. | ||
| Find more details about the schedule [on GitHub](https://github.com/eclipse-edc/Connector/discussions/1303). | ||
|
|
||
| _If you have a "contributor" or "committer" status, you will also have access to private channels._ | ||
| Thank you for your interest in contributing to this project. Please refer to the | ||
| [contributing guidelines of the EDC project](https://github.com/eclipse-edc/docs/blob/main/CONTRIBUTING.md). |