Welcome to Études for Elixir. In this book, you will find descriptions of programs that you can write in Elixir. The programs will usually be short, and each one has been designed to provide practice material for a particular Elixir programming concept. These programs have not been designed to be of considerable difficulty, though they may ask you to stretch a bit beyond the immediate material and examples that you find in the book Introducing Elixir.
This book is open source, so if you’d like to contribute, make a correction, or otherwise participate in the project, check out oreillymedia/etudes-for-elixir on GitHub for details. If we accept your work, we’ll add you to the contributors chapter.
The online version of the book is at Études for Elixir on O’Reilly Labs.
If you’re considering making a contribution, here are some guidelines to keep in mind:
If you’re new to git and GitHub and just want to keep things as simple as possible, this tutorial will give you a quick and easy way to make your contribution. Here are the steps you’ll need to follow:
To create and edit a page or to comment on an existing page, you will need to create an account on GitHub. If you don’t have one already, then go to the GitHub Signup page. It’s free.
GitHub has excellent tools for collaborating and workflow management, and will be the primary way we communicate with you over the course of the project.
Once you’ve got an account, fork (GitHub lingo for copying) the main project to your account. To do this, go to the Etudes for Elixir repository on GitHub and click the “Fork” button at the upper right hand side of the screen.
The following screen will appear while GitHub copies the repository to your account:
Once you’ve got the file created, you can start editing it at your leisure. Remember to:
To edit the file, all you have to do is click its name in the directory listing in GitHub and then press the “Edit” button.
If you want to add an entirely new topic area, you’ll need to create a new file in GitHub. To do this, click the “+” button next to the directory name to create a new file
Locate the small “+” sign next to the repository name. (A tooltip will appear that says “Create a new file here” when you hover your mouse above it.) Click the “\+” button:
In the new screen, you’ll need to:
You will see something like this:
Before you submit your request, make sure that you have:
Your biography should look like this:
.About the Author [NOTE] **** Name:: Nicola Tesla Biography:: Nicola Tesla is an inventor, electrical engineer, mechanical engineer, physicist, and futurist best known for his contributions to the design of the modern alternating current (AC) electrical supply system. ****
Once you’ve completed and double checked your submission, you’re ready to submit it back to O’Reilly. This is done by creating a “pull request” that will trigger the review process.
When you submit the pull request, you’ll also be able to submit some additional information that will help us track your work:
Once you submit your pull request, the project’s maintainers will begin a back and forth with you in the discussion features. You might be asked to make some revisions, shorten it, add additional elements, and so forth.