How to Contribute to SBo via Github Pull Requests

This guide only applies to updating your own scripts.
New submission should go through normal submission form.

1. Create a GitHub account (if you don't have one yet)
2. Fork SBo's GitHub repo (https://github.com/SlackBuildsOrg/slackbuilds/) into your account
3. Clone SBo GitHub repo from your repository to your local machine(s)
   git clone git@github.com:<username>/slackbuilds.git (if you have setup SSH keys)
   git clone https://github.com/<username>/slackbuilds.git (if you don't setup SSH keys)
4. Set SBo's GitHub as upstream to make getting public updates easier.
   git remote add upstream git://github.com/SlackBuildsOrg/slackbuilds.git

If you have never used git on your computer to make commits before, you will
need to tell git who you are so it can know who to attribute your commits
to:

  git config --global user.email "you@example.com"
  git config --global user.name "Your Name"

Now you're ready to start updating on your local computer.

1. Create a new branch for the package you're updating and switch to that
branch. Typically this will be the package name that you're updating, but
naming schemes are more for you than anything. The name of the branch won't
affect the SBo admins reviewing your pull request.
  git checkout -B <branch_name>
2. Make the changes to the files and verify everything works. This may
require moving those files to a clean VM to verify they build properly in a
clean environment. Please install sbo-maintainer-tools
(https://slackbuilds.org/repository/15.0/system/sbo-maintainer-tools)
and use sbolint to validate your changes and sbopkglint for resulting package
before sending PR to reduce the approval time.
3. Commit those changes to that branch on your local repo:
  git commit -am "<category>/<script>: <commit-message>"
  Please use a clear and informative commit message.
  If you are updating a script, use "Updated for version x.y.z":
  git commit -am "network/filezilla: Updated for version 3.66.4."
(If there are multiple package changes due to dependency bumps or similar,
do an individual commit for each package)
4. Once all commits are complete that apply to your update, push those
commits to your GitHub repo, forcing GitHub to create a new remote branch
(since it only exists locally):
  git push -f origin <branch_name>
5. Git will provide a link in the output you can visit to submit the pull
request (PR) or you can just browse to your GitHub repo and you can submit
the PR yourself (if the push was recent, it'll list the option at the top
of the nation page, otherwise you can go into the branches area and can
submit it that way.
6. Explain your changes, if necessary, when submitting the PR back to SBo's
repo. Then it's just a matter of waiting for SBo admins to review your
submission. If changes are needed, they'll suggest them.
7. In case further changes are needed, you can make changes and make a new commit
in the same branch or use git commit --amend -am and git push -f to amend your changes
and forcefully push your local changes remotely.
8. Once the changes are accepted, you can delete the branch on your repository and on your
local repo:
  git checkout master  # first make sure you're on your master branch
  git branch -D <branch_name> #delete locally
  git push master :<branch_name> #delete remotely

Once a public update is released, you can then update your local copy on
the master branch using:
  git checkout master
  git pull upstream master

Best practices:
- Make 1 PR for every script, unless it's related to one another and require spesific version of scripts
that are part of the other changes.
- Make sure to keep the permission stays 0644 for files and 0755 for directories
- Always test in a clean VM with latest update of Slackware Stable (15.0), not Slackware Current


Originally written by Jeremy Hansen, edited by SBo admins