• Contribution by adding tricky code.
• Contribution by adding more explanation for existing code.
• Contribution by enhancing the code quality or alternatives.
• Contribution by enhancing the book quality:

  • Structure enhancements
  • Spelling, proofreading enhancements
  • Design enhancements
  • Ideas and requests
  • Any other
• Contribution by spreading the book in social media and IS communities.

  • Twitter: @Rubyfu and hashtag #Rubyfu
  • Google+: Rubyfu page​
• Contribution by adding more resources and references.
• Contribution by donation.

1. 1.

   Create a GitHub account.
2. 2.

   Fork RubyFu repository.
3. 3.

   Clone GitHub forked RubyFu repository:

   git clone https://github.com/[YourGithubAccount]/RubyFu
4. 4.

   Create a GitBook account.
5. 5.

   Go to GitBook editor and Sign-in with your GitBook account
6. 6.

   Press the Import button to import the cloned repository. Then, you'll find it in the URL tab.
7. 7.

   Add the forked RubyFu repository GitHub URL to GitBook Editor in the URL tab : Home >> Import >> URL

1. 1.

   Start your awesome contribution.
2. 2.

   From GitBook editor, Sync your changes to the forked repository.
3. 3.

   From GitHub, send a Pull Request(PR) to the Master branch.

• Use the triple ticks followed by `ruby` then your code in between the to get ruby code highlighted. e.g.

  1

  puts "Ruby Code here"

  Copied!
• Explain the main idea -with some details- of the code, if you explain every line that would be great but it's not a must.
• Choose the correct Module.
• Make your title clear.
• Use Text editor/ide for code identification before pasting your code.
• Mention the source, if you copied or developed code that has been created by others; please mention the source in the footer. e.g.

  1

  puts "Your good code"

  Copied!

  1

  [Source][1]

  Copied!

  Then add the following to the footer

  1

  [1]: http://TheSouceCodeURL

  Copied!

  Your notes should be under the footer's line. Add the following to initiate the footer if it does not yet exist

  1

  <br><br><br>

  2

  ---

  3

  YOUR NOTES SHALL BE HERE

  Copied!
• Try to use readable code, if you have to add more tricky/skilled code then explain it well.

  Remember! Hacker's code =! Cryptic code

• Create a new branch for your translation.
• Add a sub-directory under Rubyfu's root directory with the name of the language you will translate to.
• Update the LANGS.md file
• Copy and paste the content of en/ folder to your language folder, then translate it.
• Create a Pull Request (PR).

Note: Since this book is enhanced dynamically and unordered, it's hard to make the footer notes with an order-series of numbers for the whole book, so -until I find better solution- I'll make the number order separate for each page individually.