search

oeed / CraftOS-Standards

Community standard file formats, communication systems, etc. for ComputerCraft and CraftOS 2.0
Other
20 stars 16 forks source link

Standard & API writing order #42

Open oeed opened 8 years ago

oeed commented 8 years ago

Although I had originally stated that the API should be written before the pull request is made I'm not so sure it's the right process. Instead I think that the API should be written after the standard has approval. The PR can then have a awaiting api label assigned to it along with accepted.

viluon commented 8 years ago

In that case, I'd suggest that the author should submit 2 PRs, one with the proposal (proposal) (which won't be merged, but you need to store the associated Markdown docs somewhere) and when that's accepted,(s)he submits another one (standard) with the actual standard and utilities.

viluon commented 8 years ago

What do you think of that @oeed ?

oeed commented 8 years ago

Hmm, actually that might work. Although, it separates things a bit too much I feel.

viluon commented 8 years ago

Agreed, although cross-referencing the PRs might help with that..

lyqyd commented 8 years ago

What's the need for a second PR? May as well make any necessary changes on the initial one, and simply not pull until it's ready. I'm having trouble seeing what the added benefit is to using a separate PR for the final standard text.

oeed commented 8 years ago

Yeah I'd agree with @lyqyd, @viluon.

viluon commented 8 years ago

Well, I know that 2 PRs is silly @oeed, but as it sort of "works" now, people open PRs when they've got nothing completed really... I'd like to fix that, just don't know how.

oeed commented 8 years ago

I don't see a huge issue with the current PRs. Sure, it'd be nice if we could merge them faster, but placing too many barriers will just deter people from contributing.