mik-laj commented on a change in pull request #246: Expand the guide for 
contributors
URL: https://github.com/apache/airflow-site/pull/246#discussion_r377593539
 
 

 ##########
 File path: CONTRIBUTE.md
 ##########
 @@ -54,49 +55,120 @@
     └── sphinx_airflow_theme
 ```
 
-## Working with the project
+# Working with the project
+
+Work with the site and documentation requires that your computer be properly 
prepared. Most tasks can
+be done by the site.sh script
+
+### Prerequisite Tasks
+
+The following applications must be installed to use the project:
+
+* git
+* docker
+
+It is also worth adding SSH keys for the `github.com` server to trusted ones. 
It is necessary to clone repositories. You can do this using following command:
+```bash
+ssh-keyscan -t rsa -H github.com >> ~/.ssh/known_hosts
+```
+
+**Debian instalation**
+
+To install git on Debian, run the following command:
+```bash
+sudo apt install git -y
+```
+
+To install docker, run the following command:
+```bash
+curl -fsSL https://get.docker.com -o get-docker.sh && sh get-docker.sh
+sudo usermod -aG docker $USER
+```
+
+Git must have commit author information configured, run these commands
+```bash
+git config --global user.email '<your.em...@example.com>'
+git config --global user.name '<you name>'
+```
+
+### Static checks
+
+The project uses many static checks using fantastic 
[pre-commit](https://pre-commit.com/). Every change is checked on CI and if it 
does not pass the tests it cannot be accepted. If you want to check locally 
then you should install Python3.6 or newer together with pip and run following 
command to install pre-commit:
+
+```bash
+pip install -r requirements.txt
+```
+
+To turn on pre-commit checks for commit operations in git, enter:
+```bash
+pre-commit install
+```
+
+To run all checks on your staged files, enter:
+```bash
+pre-commit run
+```
+
+To run all checks on all files by using, enter:
 
 Review comment:
   ```suggestion
   To run all checks on all files, enter:
   ```

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


With regards,
Apache Git Services

Reply via email to