search

PapaCharlie9 / insane-limits

PRoCon plugin Insane Limits by micovery
10 stars 9 forks source link

Removed changelog portion of the readme.md #27

Closed indy-singh closed 12 years ago

indy-singh commented 12 years ago

Just cleaning up, as there is this changelog now: https://github.com/Singh400/insane-limits/wiki/Changelog

PapaCharlie9 commented 12 years ago

Hang on, let's think about this a bit. If we are going to move the change log out of the README and into a wiki, that has two consequences:

1) People who just get the distribution by ZIP (not from GitHub) won't have the change log, whereas if it stays in the README it could be included in the ZIP

2) As the master could change from a number of different contributes, shouldn't the change log stay close to the master version of the source code?

I like the wiki stuff, particularly the examples, but we have to also think about non-GitHub distribution and what that means. Generally, distributions should be stand alone, or alterntiavely, the README could link back to a master version of the documentation.

If you are willing to do all this wiki work, it might make more sense to just promote you to collaborator and have you do all that stuff in the master version here. Are you up for that? It just means you work here instead of in your fork. You still make a branch and you still do pull requests for code. Comment here with what you think.

indy-singh commented 12 years ago

Ah I didn't think it would affect distribution like that. Just close this pull request. But I'll leave me README copy as is because it's easier for me to manage the changelog on the Wiki. Instead of having to update it in two places at once.

PapaCharlie9 commented 12 years ago

Ok I'll close it, but the bigger question is, are you willing to move all your current wiki work to this repo and continue it here? If so, I'll make you a collaborator so you can edit everything in this repo. Then we can have everything all in one place.

indy-singh commented 12 years ago

Yep, fine by me as long as I can easily transfer everything.

PapaCharlie9 commented 12 years ago

Okay, you should have access now. Make your own branch and do all your work there. When you have something to submit, do a pull request against master.

I'm not sure how easy it is to move wiki stuff. Probably cut & paste of each page individually.

PapaCharlie9 commented 12 years ago

Even better! It turns out the wiki has its own git repo:

https://github.com/PapaCharlie9/insane-limits.wiki.git

If you go to the Wiki tab here (PapaCharlie9/insane-limits) and then click on Git Access, you can see the git repo. It doesn't have a convenient Clone button like the source repo, but you can use command line to clone it, following the boot camp/tutorial help docs here on the site.

You can clone that repo, make a branch, do work in the branch, and then submit the changes as a pull request. Or, you can just work directly in the master branch for the wiki repo -- probably easiest.

Your repo should have one for your wiki also. If you clone that AND clone this one as well, and just copy all the files from your master to this master and sync this master, that should be all that's needed.

indy-singh commented 12 years ago

Make your own branch and do all your work there

Will my current "fork" not suffice? I just got to grips with how GitHub works, I don't want to go messing up (in either my fork or the master repo!).

Great news about the Wiki syncing. So I can make my Wiki the 'master' then when I do a big update on the wiki and can send a pull request to your from my wiki, right?

PapaCharlie9 commented 12 years ago

I think you are right! You should be able to just do a pull request against https://github.com/PapaCharlie9/insane-limits.wiki.git from your fork. Actually, you probably have to fork insane-limits.wiki.git first, then do your work, then submit. It's a completely separate repo.

Let me know if you need help with the command line commands.

PapaCharlie9 commented 12 years ago

Looks like GitHub does not support Pull Requests for wiki repos. I asked support, here's what they said:

From: Petros Amiridis (GitHub Staff) Subject: Relationship of repo.wiki.git to fork.wiki.git? How to fork?

Hi,

GitHub pull requests do not work for wikis.

You would have to fetch/merge or try the traditional Git pull requests.

Petros