Home

Welcome! This wiki serves as the documentation for this project.

#Want to contribute? Read this first :)

git_beginners_guide is a book for the beginners of git . Unlike a wiki though, the editing process does not take place on the website itself; instead, it happens here, on GitHub. If you don't know about Git, head to Git's official website, or consult the very apt and to-the-point GitHub help on Git.

Making changes to ruby-lang.org is quite easy:

1. find something to add/fix/update
2. propose your change here (how exactly? See below)
3. wait for a review and approval
4. enjoy once your change has been deployed!

The website is updated on a regular basis: your approved edits will show up when a team member triggers a new deployment (usually right after the edits have been approved).

#How to propose a change

If there is something you want to edit, the process is rather simple. First, create a GitHub account and log in. Then, it depends on whether you want to do a quick edit, or something more involved.

#The quick way Simple edits may be performed directly on GitHub, using the "Edit" button while browsing the file you want to edit:

• head to the repository containing the website code
• browse the files to display the one you want to edit (a description of the project structure is available here
• click on "Edit" and make your changes
• When everything looks fine, click the "Propose File Change" button
• Provide a good rationale for your request, and click on "Send Pull Request" to complete the process

A new pull-request will be created with your changes. A member of the editorial team will review your request and eventually merge the edits in if all is good. If not, you will most likely receive some insights through a comment on your pull-request and will be automatically notified.