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.

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

Update contribution guide #9

Merged
merged 2 commits into from Sep 9, 2019

Conversation

ghost
Copy link

@ghost ghost commented Jul 29, 2019

  • Replace information CONTRIBUTING.md because it is redundantly stored
    in each project repository. Instead, CONTRIBUTING.md now links to the
    project website that centralizes the information.
  • Links to kuksa-dev mailing list and Zoom meeting added.
  • References to Bugzilla have been removed because GitHub issues are
    used instead.
  • Clean code is mentioned to encourage a good code style and be able to
    refer to it when reviewing pull requests.
  • The documentation section has been updated to what has been agreed on
    lately.
  • Practical hints for commit style have been added.

Signed-off-by: Sebastian Lohmeier Sebastian.Lohmeier@bosch-si.com

* Replace information CONTRIBUTING.md because it is redundantly stored
in each project repository. Instead, CONTRIBUTING.md now links to the
project website that centralizes the information.
* Links to kuksa-dev mailing list and Zoom meeting added.
* References to Bugzilla have been removed because GitHub issues are
used instead.
* Clean code is mentioned to encourage a good code style and be able to
refer to it when reviewing pull requests.
* The documentation section has been updated to what has been agreed on
lately.
* Practical hints for commit style have been added.

Signed-off-by: Sebastian Lohmeier <Sebastian.Lohmeier@bosch-si.com>
Copy link
Contributor

@rohoet rohoet left a comment

Choose a reason for hiding this comment

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

Looks good to me 🙂

In general, we can also use the staging branch in this repository, which makes local checkout + build obsolete since we can then use the automated staging build for checking the website build results.

@SebastianSchildt
Copy link
Contributor

Nice. I guess to enfor.. encourage this, reviewers should also check and suggest changes if some PRs are not conforming. And I know, I will soon regret suggesting this...
And what is the convention for a PR that is not attached to any issues, e.g something annoys me, and I just fix it/add a feature?

And I do not quite agree to the artificial squashing of things. . It creates work, and helps nobody. A commit can't be small enough. Squashing makes regression testing quite hard, because yeah maybe there was one breaking change in one line, but now it is lumped together with 1000 other commits.

For indicating larger milestones/chunks of work there are tags in git.

@rohoet rohoet merged commit e006846 into eclipse-kuksa:master Sep 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants