Skip to content

PMC project guidelines

Александър Куртаков edited this page Jun 15, 2022 · 22 revisions

This page is used to document project standards and guidelines.

Issues

With the move to Github the usage of issues and pull requests became relatively similar. PR and issues can both be commented on, referred to and linked to.

Hence the PMC decided that you do not need to create an issue for functional changes in case you can directly publish the code change as PR. Issues are still valuable for users to report issues or for changes which you plan to do in the future or at multiple steps etc. PR should be preferred in case you can, so that the discussion involves both the code change and the design.

We hope that this will reduce the noise the project members receive and remove additional steps in the process which do not add value. Most of the documentation of a final change should be in the commit message and the surrounding discussion can be captured either in the issue or the pull request.

Subprojects are free to require a separate issue for each PR if they agree that that is the best workflow for their area.

Commit messages

Each commit should be well documented via the commit message, the commit body should give an explanation why you are doing this change.

It is not sufficient to describe that in the PR or issue, it should be part of the commit message.

To be filled with guidelines regarding the UI updates removal of unmaintained functionality and other topics.

Committer disagreement resolution

In the case committers disagree on given topic they are supposed to follow the management chain order for resolution. Commit reverts (unless resolving breakage!) and non-technical heated disputes SHOULD NOT happen. The following list explains actions to be taken by contributors to resolve issue:

  • Ask Project Lead(s) for resolution on the topic.
  • Project Lead(s) should clearly state their resolution is as Project Lead to eliminate chances that people are not aware of hierarchy.
  • In case of disagreement with a Project Lead issue MUST BE brought to Eclipse PMC for decision.
  • Eclipse PMC decision is FINAL .

UI Guidelines:

Tbt. currently in discussion of the PMC

Operating System UI Guidelines

Gnome UI guidence https://developer.gnome.org/hig/patterns/feedback/dialogs.html

Mac UI guidence https://developer.apple.com/design/human-interface-guidelines/components/presentation/alerts/

Windows UI guidence https://docs.microsoft.com/en-us/windows/apps/design/controls/dialogs-and-flyouts/dialogs

Clone this wiki locally