The Spirit
The project is run in a collaborative spirit, where we share each other's knowledge helping one anothers, it is therefore very important to contribute to the project.
Each contribution is important helps the project reaching the target audience in a meaningful manner, making the difference in other peoples linux experience!
Every contribution count! If you asked help it means someone else eventually will ask for help solving the same problem: why not writing the solution to the website? A novice that just installed linux knows the struggle better then a developer that has setup his laptop years before!
Help-providing contributions
This is the type of contribution that keeps the community alive: answering to people's questions when they join discord with theirs problem and helping them providing info that will be useful to solve the issue quickly. It is a big part of the community!
Technical Contributions
Technical contributions are very welcome and you can choose how much time and efforts to dedicate.
Technical contributions means code, documentation, writing guides and small tutorials.
Technical contributions takes the form of modifications to repositories part of the asus-linux gitlab organization.
Preparations
First grap needed tools:
sudo pacman -S code git
You will need a gitlab account. You can create one for free or using one of the many supported third-party accounts like Google or github.
The next step is to create your ssh key and adding it to your account. Don't let the documentation scary you: it's a simple matter and takes a few seconds.
Create the ssh key if you don't have one already:
ssh-keygen -t ed25519 -C "gitlab"
# follow the guided procedure
eval $(ssh-agent -s)
ssh-add $HOME/.ssh/id_ed25519
cat $HOME/.ssh/id_ed25519.pub
# Copy the output: you will need it later
In your browser go to gitlab.com and click on your profile picture and then SSH Keys on the left.
Use the button "Add new key" and copy the content you copied before. That's it.
Forking the repository
To contribute you will need to send a PR: these are the modifications you made. To make modifications find the project you want to contribute to and fork it.
For example let's say you want to add a small guide to the website, you will need to find the website project and fork it using the button on the upper left: this will add a copy of the website to your account (once you provide the final confirmation).
Cloning the code
At this point you will be redirected to your own copy of the website: to do modifications you will need to download the code: click the colored "Code" button and copy the link in "Clone with SSH", then with that clone the repository:
# Replace $URL with the copied URL
git clone $URL
And with that a copy of the project will be created on your disk. Then just enter it and launch an editor (for example Visual Studio Core):
cd website
code .
NOTE if someone makes the wrong move of criticizing VSCode please remember them what editor modified the kernel they are running on theirs laptop. Yes, that's right.
Editing the code
You can now use vscode to modify the website. When you are done use the git integration on the left (icon is three small circles connected with one line and a curve) to send your contribution back to gitlab: add files you modified using the + button (you can also click on them and see what you changed), write a meaningful message explaining what you did and "Commit"; after commit is done the button will become a Sync button with two arrows: click that and you will be ready to send a PR!
To send a PR (what the administrator will have to approve) head back to your fork in gitlab and use the propt that appeared above the list of files.
That's it. Someone will get back to you when they have time.
