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 CONTRIBUTING.md with more Contributing Guidelines #232

Open
AdamBrousseau opened this issue Feb 22, 2018 · 3 comments
Open

Update CONTRIBUTING.md with more Contributing Guidelines #232

AdamBrousseau opened this issue Feb 22, 2018 · 3 comments
Milestone

Comments

@AdamBrousseau
Copy link
Contributor

I think it would be a good idea to add some more contributing guidelines to the CONTRIBUTING.md.
Similar to what what done at eclipse-omr/omr#124.
It would be nice if we could just copy/paste the relevant sections we want from OMR's CONTRIBUTING.md. We would just have to figure out the license/copyright hoops to jump through to do that.

Perhaps @tellison has some insights on the legal aspects?

@sxa
Copy link
Member

sxa commented Oct 1, 2021

There have been various updates to the CONTRIBUTING.md since then, but it would be good to do a check to see if there's anything we could use from the OMR one, so I'm not going to close this, but bump it into the current iteration to get some attention and hopefully work to close it off.

@sxa sxa self-assigned this Dec 1, 2021
@sxa sxa modified the milestones: October 2021, December 2021 Dec 1, 2021
@Willsparker
Copy link
Contributor

Having a brief look at this whilst I go through issues. I've compared the two and these are my thoughts:

  • The OMR one links to a Git Crash course file, which, imo, is a very good idea. Could we link to the same crash course in our repo? Or possibly link @sxa 's one?
  • 's/AdoptOpenJDK/Adoptium/g' in our one.
  • There's some additional points under submitting a contribution in the OMR one, that could probably be added to our one: points 1 and 3 in particular.
  • The OMR one has a section that explains issue labelling. While we have issue templates, a small section to explain both those templates and the labels may be helpful.
  • Our 'Eclipse Contributor Agreement' section could be bulked out a bit, like OMR's 'Legal Considerations' section, where it explains exactly how to sign the Eclipse Contributor Agreement, as opposed to ours that just links to the agreement itself.

Not too much? I'm happy to make those changes, or everyones in agreement with the above points, or have any additional points they want to add :-)

@smlambert
Copy link
Contributor

@sxa sxa modified the milestones: December 2021, 2022-01 (January) Jan 6, 2022
@sxa sxa modified the milestones: 2022-02 (February), Backlog Mar 3, 2022
@sxa sxa removed their assignment Feb 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Todo
Development

No branches or pull requests

5 participants