search

MPCatalog / scom-community-catalog

This repository stores the MP information for the SCOM Community Management Pack Catalog
http://www.squaredup.com/MPCatalog
GNU General Public License v3.0
26 stars 18 forks source link

Improve contribution guidelines on the Wiki #16

Closed shadeon closed 7 years ago

shadeon commented 7 years ago

It would be great if the Wiki could be extended with some contribution guidelines and/or any criteria that must be met for a PR to be accepted.

For example, I hear the index.json file needs to be alphabetically sorted - if this is the case it should probably be stated so moderators don't need to comment on most PRs if the author didn't happen to naturally do this.

shadeon commented 7 years ago

Just to let you know I've started to write up the steps required to contribute to the repository using VSCode and git (on windows). I can't submit a PR for the Wiki, but will post my text here for your review, and then you can either use this as a base or copy wholesale to the wiki if you like it 😄

These steps are likely to be the one's i'll provide on the Coffee Break so would appreciate your feedback either way!

P2P-Nathan commented 7 years ago

That sounds great.

I am working on instructions for making quick edits and adjustments on the GitHub site, for those that just want to correct a version or MP name. Hopefully as simple as Edit File > New Branch > New PR, with a couple screenshots. I'm hoping the whole process to make a simple update could be 30 seconds or so, then there will be very little friction for a user to just update the version number or a simple spelling correction.

I'll combine both into the page once complete.

On Fri, Oct 27, 2017 at 8:49 AM, Matthew Long notifications@github.com wrote:

Just to let you know I've started to write up the steps required to contribute to the repository using VSCode and git (on windows). I can't submit a PR for the Wiki, but will post my text here for your review, and then you can either use this as a base or copy wholesale to the wiki if you like it 😄

These steps are likely to be the one's i'll provide on the Coffee Break https://squaredup.com/coffee-break-series so would appreciate your feedback either way!

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHub https://github.com/MPCatalog/scom-community-catalog/issues/16#issuecomment-339976660, or mute the thread https://github.com/notifications/unsubscribe-auth/ARCe2gaIgoYPDJEmUySL5bUPzU9575pfks5swd9igaJpZM4QGMqA .

shadeon commented 7 years ago

Wasn't aware you could do it that way (without being a contributor), definitely the way to go for people making simple edits to existing content.

shadeon commented 7 years ago

Further documentation on contribution has been added, satisfies what I needed to know.