-
Notifications
You must be signed in to change notification settings - Fork 5
Home
Welcome! This little Wiki gives you all the information you need to contribute to the InsertCoin documentation project.
The InsertCoin documentation is a project hosted here on GitHub.com and therefore it's maintained in a Git repository. If you don't know what Git is or why we have chosen to use it for this project, please read Git, WTF?.
That means you need a GitHub account to take part. If you haven't got one already, now is the time. It's completely free and you only need a username, a password and an email address. No further personal information required.
Once you have set up your account, you can fork the project by clicking the Fork button above. It's also a good idea to watch the project if you want to be informed about recent changes. This can be controlled via the Watch (or Unwatch) button.
Forking the project will create a complete copy of everything and assign it to your account. That means you now have your own repository which you can edit as much as you like. Changes made here will only affect your own repository, not the official “upstream“ repository which you forked moments ago.
If you think you've done something useful to the documentation, send a Pull Request (again, click the corresponding button), write a description of what you did and maybe why you want your changes to be applied. Click OK and we'll be notified that you have been working on the docs. We'll then review the changes and apply them.
If you don't want to fork the repository (be it for the reason that you want to get around Git or whatever), you can also open a ticket in our issue tracker. Describe what you want to be changed and we might do that for you. Be aware, that this means more work for us. If you can, please fork the repository and use Pull Requests.
Good question. First of all please don't be overwhelmed by all Git can do for you. It's actually quite simple. You don't have to know more than a few commands (and if you use a graphical tool such as tortoisegit not even that).
How exactly you need to handle Git depends on which operating system you use and whether you prefer working on the command line or better use a graphical tool. Whereas the command line way is pretty much the same on all systems, the latter way might differ a lot. Decide what you want and read one of the following guides:
- Command Line Git (platform independent)
- SmartGit (platform independent)
- TortoiseGit (Windows only)
- Giggle (Linux only)
- GitX (OS X only)
- gitnub (OS X only)
For more information about how to edit the files, which directories to use, how to start a translation and general rules for spelling, grammar and writing style, please consult the README file in the root directory of the repository.