Editing with Forks
We use forks because they give some benefits when making big changes to a GitHub repository.
Note: If you want to add a rule or category/top category, this is the wrong page for you! See How to Create Rules and How to Add and Edit Categories and Top Categories.
To edit a rule with your forked repository, follow these steps:
- Go to your forked repository: {User}/SSW.Rules.Content. If you don't have a fork of the SSW.Rules.Content repository, see Fork the repository (One-time setup) section below.
- Navigate to a file you want to change. You can use the
Go to filebutton to search for a rule.
Figure: Search for your file by clicking Go to file
- Click on the pencil button to edit the file.
Figure: Click edit a rule
- Once you are happy with your changes, scroll to the bottom of the page to the commit box. Add a useful commit message and description, and make sure you are committing directly to the main branch of your forked repository.
Figure: Commit your changes
- Merge your changes, by following Merging Your Fork
Warning: Remember to Enable Workflows in step 6. Skipping this step will generate an error and you won't get credit for the content change!
-
Log in to GitHub, or create an account if you haven't already.
-
Navigate to SSW.Rules.Content - https://github.com/SSWConsulting/SSW.Rules.Content/
-
Fork it!
Figure: Fork this repo!
Forking makes a duplicate of the Rules repository (i.e. SSWConsulting/SSW.Rules.Content to SSWSophieBelle/SSW.Rules.Content). As SSWConsulting/SSW.Rules.Content is a public repository, we do not have permission to write to it directly. This is for security reasons.
- Fork it under your own GitHub account:
Figure: You'll need to create a GitHub account if you haven't.
- You should end up with your own forked repository:
Figure: Check that it has YourAccountName/SSW.Rules.Content on the left
- IMPORTANT: Enable Workflows in your GitHub Fork
Figure: Enable Workflows on your GitHub Fork