search

ClusterM / hakchi2

Tool that allows you to add more games to your NES/SNES Classic Mini. WARNING: hakchi2 is no longer supported. Please use hakchi2 CE.
GNU General Public License v3.0
2.93k stars 456 forks source link

Contribution/development guide #1186

Open jbw976 opened 6 years ago

jbw976 commented 6 years ago

To help potential new contributors to this repo get involved and contribute changes, a contribution and development guide would be an excellent resource. Here's an example from a repo that I am a maintainer for: https://github.com/rook/rook/blob/master/CONTRIBUTING.md https://github.com/rook/rook/blob/master/Documentation/development-flow.md

Some of the following topics would be especially useful:

  1. recommended development environment and tools
  2. how to build and run the app from source code
  3. how to test code changes, run unit/integration tests, and how to write new test cases
  4. how to debug and troubleshoot issues

Does a resource like this already exist in the hakchi2 repo? Thanks!

jbw976 commented 6 years ago

A contribution guide would be quite useful for attracting more developers to help out with this project, increasing the number of features that can be implemented and bugs that can be resolved.

I'm posting this as an issue in this repo because it's an improvement that could be made to this repo. Where would be a better place to capture this request?

jbw976 commented 6 years ago

My suggestion here would be for an experienced hakchi2 contributor to push a commit to this repository that includes the contribution guide readme/markdown, with the content described in the beginning of this issue.

My request would result in a pushed commit to this repo, sounds to me like a reasonable thing to track as an issue in this repo.

Drakonas commented 6 years ago

Woah @Shoothimnow I don't think you're understanding the OP's request. This is definitely a good idea. He's just asking for someone to push a commit for documentation on how to better contribute one's own code to Hakchi2.

Shoothimnow commented 6 years ago

We are getting more garbage posts daily, without any cleanup. All I asked for was a justification. Down me all you want, but I am tired of idiots posting. If the title included "Feature Request: " I wouldnt have said anything

Drakonas commented 6 years ago

That's what I am here for to label them as a feature request once I see them. :) I apologize that I haven't been around to help clean up. I've been having some direct family illness trouble for the last few months.

dbelyaev commented 6 years ago

@Shoothimnow woah, I think you got somehow blind by all this "help needed" posts around here. I don't think I need to explain what an open source community is and just want to ask you to be more polite and not so edgy.

I completely agree with OP that contributing guide and how to build instructions could be a great idea.

Shoothimnow commented 6 years ago

@dbelyaev woah, way to join the fun 20 days later. Again, all I asked for was justification (as I did with all the 50+ other garbage posts as @Drakonas was unavailable for a month). But hey, sure, let's bring something up that has been dead for 20 days, sure. Again, if Feature Request was added to this in the very beginning, I wouldn't have said anything. 20 days later @dbelyaev, yeah, its there now.

Regarding being more polite, I would ask you to read #1123. I'm happy not a single person here that has said "woah Shoot, that's too far" has posted anything over there (at all - took @Drakonas 29 days to add the feature request). But yet, in my "blindness for all this "help needed' posts around here on this open source community, I'm glad I could help a brother out and that everyone else thinks that post number 2 is a laughing joke (on the google search post from 1123).

dbelyaev commented 6 years ago

@Shoothimnow it is never to late (actually I forgot to check the date) :)

I am sorry that you feel that way by reading my comment and went all the way to explain it to me. Thanks for your time.

Shoothimnow commented 6 years ago

Oh it's fine, if you would have posted this when I posted it, you would have had more context. But 20 days later after everything has already been addressed, you are just now poking the bear. Most of the posts I put about "hey, can you justify this", no one ever cares to post back, because they are One and Done posts. This ^ ^ ^ clearly wasn't the case (which I support). Just wanted some justification with that comment I deleted. And we got the justification. That same week I probably posted on 15-20 other posts. We finally got 1 of 14-19 that is relevant of being here, woot!