Skip to main content

Onboarding

Here are a few resources to help you get started with contributing to Enarx (and to free and open source projects in general).

The idea here is to get you familiarised with the contribution process and the tools in a general sense, and used to the project itself which is rather complex, allowing you to be "waiting, but not idle" as you find where you want to contribute.

Learn about contributing to open source

If you are new to contributing, Opensource.com's guide on how to contribute is a good place to start.

Learn how to use Markdown

Enarx makes extensive use of Markdown as a way to write and format text (both code and documents). If you are unfamiliar with Markdown, please check more at mastering Markdown.

About wrapping text

It is common practice to "wrap" text at a certain number of characters, that is, make each line no more than a certain number of characters. In the Enarx project, we wrap text at 80 characters.

How to configure your text editor or IDE to to do so will vary. However, you can always use the following command to show a wrapped version of your text at 80 characters, provided you are using a UNIX-based system (Linux, BSD, macOS):
fold -w 80 -s my_text_file.txt

To directly save that output to a new file:
fold -w 80 -s my_text_file.txt > my_text_file_wrapped.txt

Create a Github account

To contribute to Enarx, you will need a Github account to be able to open issues (see below), contribute code or help improve the documentation. You can create one here.

Note that you do not need to use your personal information to create an account if you don't feel comfortable using your real name, for instance. Friendly reminder however that the Code of Conduct still applies, of course.

Understand how "issues" work

One of the Github functionalities we make heavy use of are "issues", which is a generic term to describe things we want to keep track of, bugs or improvement ideas. Github has several explainers on issues:

You can see the Enarx issues here

Join the chat

Join the chat at chat.enarx.dev and come say hi, ask questions, or just read the conversation. We also have GitHub discussions.

Anything else?

That's it! At this point, you should have everything you need to start contributing. If you feel anything is missing here, please let us know.