search

eclipse-jdt / .github

0 stars 5 forks source link

Updated language und simplified Contributing.md #12

Closed tsmaeder closed 2 years ago

tsmaeder commented 2 years ago

I've rewritten Contributing.md a bit with the following goals:

  1. Fixed some language issues
  2. Suggested a simplified fork/PR workflow
  3. Changed some suggestions about PR messages: now that we can have multiple commits in a PR using the issue title does not make sense in my view: issue titles describe the problem, not the code changes (unless they are really "tasks")
  4. Separated contributing a PR from reviewing a PR:
tsmaeder commented 2 years ago

@merks

tsmaeder commented 2 years ago

@akurtakov

merks commented 2 years ago

Generally it looks fine. You likely missed broader discussions on platform-dev though...

One problem I have with the workflow you describe is that I must manually sync my fork with the main repo via Github. With the help of @iloveeclipse I found this pattern better:

image

I.e., clone the main repo and have the origin remote use that. The master branch also uses origin. The other remote (merks in my case) is the fork and I use it only to push branches to my fork. When I'm done, I switch back to master and can pull, never having to worry that my fork's master is not in sync with the real repos master. And you say nothing in your instructions about the need for manual syncing because I suppose people should just know, but I didn't know...

It's annoying that every single project will need to document this again in parallel, maybe with each having its on variation...