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

Add CONTRIBUTING guide #104

Merged
merged 1 commit into from
Sep 24, 2019
Merged

Add CONTRIBUTING guide #104

merged 1 commit into from
Sep 24, 2019

Conversation

elskwid
Copy link
Member

@elskwid elskwid commented Sep 24, 2019

Overview

Adds initial contributing guide.

Details

Adds a starting point for our contributing guide focused on the basic process of:

  1. Gaining a little background information for how community contributions are handled
  2. Thinking about how this project might look a little different than the raw specifications
    1. I lifted a section from the Python guide that talks about "capabilities not compliance" as result of this discussion
  3. The basic mechanics of contributing

Things we could add

There might be some other things we could add in here like:

  • Any design rationale for standout difference between this and other libraries or the spec
  • Links or information on style: commits, language, etc
  • RuboCop usage (or expected usage)
  • Bug reports (I notice that the JS folks have a section on this and it seems like it could be helpful in the future)

Adds initial contributing guide.
Copy link
Contributor

@fbogsany fbogsany left a comment

Choose a reason for hiding this comment

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

Thanks @elskwid! I like this as is. I also like the "things we could add", but I'd be happy to merge this as is and open issues to add those things. I've been thinking recently about the first one, since we have some distinct Ruby-isms in our codebase that differ significantly from other implementations.

@elskwid
Copy link
Member Author

elskwid commented Sep 24, 2019

@fbogsany Thanks for the review! I'm perfectly happy with a merge now. I can create issues for the "things we could add" and we can set aside time later on.

@fbogsany fbogsany merged commit 0ac1f13 into open-telemetry:master Sep 24, 2019
@elskwid
Copy link
Member Author

elskwid commented Sep 24, 2019

🙇

I added #105 (design rationale), #106 (style), #107 (bug reports).

@elskwid elskwid deleted the add-contributing branch September 24, 2019 15:35
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.

2 participants