Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update commit requirements in Contributing page #3554

Merged
merged 1 commit into from
Oct 6, 2023
Merged

Update commit requirements in Contributing page #3554

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,18 @@ In order to get you started as fast as possible we need to go through some organ

## Eclipse Contributor Agreement

Before your contribution can be accepted by the project team contributors must
In order to be able to contribute to Eclipse Foundation projects you 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
contribution has been provided to the project. The non-committer must
additionally have an Eclipse Foundation account and must have a signed Eclipse
Contributor Agreement (ECA) on file.
The ECA provides the Eclipse Foundation with a permanent record that you agree
that each of your contributions will comply with the commitments documented in
the Developer Certificate of Origin (DCO). Having an ECA on file associated with
the email address matching the "Author" field of your contribution's Git commits
fulfills the DCO's requirement that you sign-off on your contributions.

For more information, please see the Eclipse Committer Handbook:
For more information, please see the Eclipse Project Handbook:
https://www.eclipse.org/projects/handbook/#resources-commit

## Making your Changes
Expand All @@ -41,7 +41,6 @@ https://www.eclipse.org/projects/handbook/#resources-commit
* Use descriptive and meaningful commit messages. In particular, start the first line of the commit message with the
number of the issue that the commit addresses, e.g. `[#9865] Add token based authentication.`
* Squash multiple commits that are related to each other semantically into a single one
* Make sure you use the `-s` flag when committing as explained above
* Push your changes to your branch in your forked repository

## Submitting the Changes
Expand Down
19 changes: 9 additions & 10 deletions site/homepage/content/community/contributing.md
View file
Open in desktop
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Point 6 in the Making your Changes list (Do not forget to add yourself or your organization to the copyright holder list in the NOTICE file ...) also doesn't seem necessary anymore.
See https://gitlab.eclipse.org/eclipse/technology/dash/org.eclipse.dash.handbook/-/issues/96
and the example NOTICE file here.
@sophokles73 Shall this be changed here as well, or would you rather keep the list in the NOTICE file?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the time being, we should keep it because I do not really see how we could achieve the same results by means of just the Git commit log when authors use a (private) email address that give no clue regarding their affiliation. I will discuss this with the Eclipse Foundation, though ...

Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,18 @@ You might also want to take a look at our [GitHub Issues](https://github.com/ecl

## Eclipse Contributor Agreement

Before your contribution can be accepted by the project team contributors must
In order to be able to contribute to Eclipse Foundation projects you 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
contribution has been provided to the project. The non-committer must
additionally have an Eclipse Foundation account and must have a signed Eclipse
Contributor Agreement (ECA) on file.
The ECA provides the Eclipse Foundation with a permanent record that you agree
that each of your contributions will comply with the commitments documented in
the Developer Certificate of Origin (DCO). Having an ECA on file associated with
the email address matching the "Author" field of your contribution's Git commits
fulfills the DCO's requirement that you sign-off on your contributions.

For more information, please see the Eclipse Committer Handbook:
For more information, please see the Eclipse Project Handbook:
https://www.eclipse.org/projects/handbook/#resources-commit

## Conventions
Expand Down Expand Up @@ -73,8 +73,7 @@ https://www.eclipse.org/projects/handbook/#resources-commit
9. Commit your changes into your *feature branch*.
10. Use descriptive and meaningful commit messages.
11. Squash multiple commits related to the same feature/issue into a single one, if reasonable.
12. Make sure you use the `-s` flag when committing in order to add a *Signed-off-by* footer as mentioned above.
13. Push your changes to your branch in your forked repository.
12. Push your changes to your branch in your forked repository.

## Submitting the Changes

Expand Down