search

Attnam / ivan

Iter Vehemens ad Necem - a continuation of the graphical roguelike by members of http://attnam.com
GNU General Public License v2.0
301 stars 43 forks source link

Create CONTRIBUTING.md #552

Closed ryfactor closed 4 years ago

ryfactor commented 5 years ago

I've felt for some time now that we could have a guideline for contributing. Here's my suggestion for a contribution guideline, based on my observation of how how people have been contributing over the years. It's not exhaustive by any means, please feel free to make any changes based on your own observations and collaboration experience. As usual, there is no time frame for completion.

One feature I would like to see is if a PR is approved, then anyone including the author can merge that PR. Not sure if this is useful, but it feels like this builds consensus and is more laid back. I don't know how anyone else feels about merging ones own work, but maybe there are circumstances which merit this?

I think we can mention the useful feature of GitHub's draft PR to distinguish between work in progress and stuff that is ready to be reviewed/merged.

There's also a things to do, a job list, and a forbidden jobs. Upsetting the balance is probably the worst, after coding bugs. I think there are probably enough materials and weapons at this stage in development.

jakwings commented 5 years ago

I only have issue about squashing commits when merging:

AquariusPower commented 5 years ago

if a PR is approved, then anyone including the author can merge that PR.

anyone?

just some thoughts... It should be limited to the last commit til the approval (that should be an action/trigger/checkbox detected by github allowing one merge only, and not a mere comment even from a recognized member), so new commits would require re-approval (only members can do that), but I dont really know how much can be configured in that way...

2) Fix bugs before coding more bugs.

may be it could be something like (but shorter): When coding new things, if you find any bugs related to what you are coding, and that you believe you can fix (otherwise create an issue), try to fix them first mainly to avoid compromising the quality of the very functionality you are adding/improving.

andrewtweber commented 5 years ago

Thanks for putting this together @fejoa

anyone?

@AquariusPower I think only people who are assigned to the Developers team on the Attnam organization have permission to merge. Maybe the documentation should be more clear on that.

ryfactor commented 4 years ago

@red-kangaroo haha, yes thanks for pointing out the missing full stop. The new materials embargo is probably outmoded and I think we can dispense with it. (Yes, you got me, I am guilty of introducing asthetic materials as well :E ) I'll make some more changes when I next get to a terminal, hopefully by Tuesday.

ryfactor commented 4 years ago

PR #605 should do the trick