Thanks for your interest in contributing! Please read carefully through our guidelines below to ensure that your contribution adheres to our project's standards.
We use GitHub Issues to track all tasks related to this project.
There are three steps to set up a working environment:
A fork is a copy of a repository. Forking a repository lets you to make changes to your copy without affecting any of the original code.
Click Fork (in the top-right corner of the page) to copy this repository to your GitHub account.
A clone is a downloaded version of a repository. Cloning our fork lets you download a copy of the repository to your computer.
Use git clone to clone your fork
$ git clone https://github.com/symnixhq/symnix-image-scraper.git
If you followed the steps from above, you now have the repo on your computer. Now go into the repository folder and add your changes.
For example, if you are working in the ~/dev directory:
cd ~/dev
vim /file/you/want/to/change
save your changes
Remember how making changes on a fork doesn't affect the original code? Well, in order to fix an issue in the main project, you want to change the original code. A pull request is a GitHub feature that lets you do just that!
There are three steps to submitting a pull request:
First, get a list of all the files you have changed.
$ git status
Next, stage the file you want to save. This will add the file to a new list that is ready to be saved.
$ git add /files/you/changed
Save your staged files.
$ git commit -m "improved feature X for symnix-image-scraper"
Use the git push command to add your local made changes to your remote fork
$ git push origin main
- Find the Create Pull Request button
- Select compare across forks
- Add your forked branch and select the right base repository
- Click Create Pull Request
By contributing, you agree that your contributions will be licensed under its GPLv3 license.