umbraco / UmbPack

13 stars 13 forks source link

Add contribution guidelines #45

Open jmayntzhusen opened 4 years ago

jmayntzhusen commented 4 years ago

With rising interest in UmbPack we are of course interested in having more people contribute. Contribution guidelines that give a quick overview of the codebase and how you can test things would be nice to make it easier for newcomers to dive in!

Should cover things like:

@mattbrailsford anything you had trouble figuring out when you made PR's in the past you'd have loved to be documented somewhere? 🙂 @nathanwoulfe, likewise if you hit a wall with something related to contributing to UmbPack please add it here so we can get it documented!

mattbrailsford commented 4 years ago

I guess the difficult thing is testing it without having a package to deploy somewhere. Maybe not so much documentation, but maybe we need a mode where it would perform all the tasks, including maybe hitting the APIs but it says it's in test mode so that it can verify everything runs successfully and nothing is actually persisted. Maybe in test mode it can write a report of what it thinks would happen if it ran.

I really didn't want to have to deploy a local version of Our just to see if it works.

jmayntzhusen commented 4 years ago

Hmm a dry-run feature could be really nice! A bit outside the scope of what I had intended with this issue, but I like it!

mattbrailsford commented 4 years ago

@jmayntzhusen agreed it's out of scope of this issue, just you asking made me think of it 😁