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

README: Flesh out and add a simple description #17

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

richlowe
Copy link
Member

No description provided.

Copy link
Member

@rzezeski rzezeski left a comment

Choose a reason for hiding this comment

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

Rich, thank you for taking the time to give some details on the IPD process. Overall I find this to be a major improvement to what we currently have, so feel free to ignore any and all comments I've made in the spirit of getting something better out there.

impact) project wishing to make changes to illumos. They should describe the
what and the why and give people the opportunity to comment on both.

An IPD is at its heart, just a README.md in a numbered directory in this
Copy link
Member

Choose a reason for hiding this comment

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

I guess I'm the only one who did an .adoc, haha. I'd say we should allow either. And if that's the case maybe rephrase this like "An IPD consists of either a markdown or asciidoc README file in a numbered directory".

long-term project that will likely integrate in pieces, to provide the overall
picture.

For your first contribution, you might want to just submit a pull request to
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
For your first contribution, you might want to just submit a pull request to
For your first contribution, you should submit a pull request to

[@jclulow](https://github.com/jclulow) or open an issue against this
repository.
Contributions are welcome. A good rule of thumb as to whether you _should_
have an IPD is whether you are making a change with high impact to other
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
have an IPD is whether you are making a change with high impact to other
write an IPD is whether you are making a change with high impact to other


For your first contribution, you might want to just submit a pull request to
this repository. Going forward if this is a thing that you will do again,
we'll probably give you write access to this repository so you can just add
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
we'll probably give you write access to this repository so you can just add
we'll probably give you write access to this repository so you can add

#### predraft

You've started writing your IPD and you want to share it narrowly, or even
just to reserve your a number in this repository. You're _predraft_, maybe
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
just to reserve your a number in this repository. You're _predraft_, maybe
just to reserve a number in this repository. You're _predraft_, maybe

Comment on lines +94 to +95
"Sponsor" is a weird word here, it's just the person or people on the illumos
core team who were ok with your IPD. Don't worry about it.
Copy link
Member

Choose a reason for hiding this comment

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

Rich, first I want to be clear I'm happy someone took the time to flesh out the IPD process a bit. But I can't help but read this and wonder why we even have sponsorship if it's something no one should worry about and it's "weird"? If we can't explain what it is to the general public, maybe we don't need it?

It seems like the sponsor is the illumos core member who agreed the IPD should be moved to the published state? If so that seems easy enough to explain.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants