Skip to content

woof CE Contributor 101

Jump to bottom Edit New page
Lakshay Rohila edited this page Dec 3, 2022 · 15 revisions
  1. Sign up to GitHub
  2. Go to https://github.com/puppylinux-woof-CE/woof-CE
  3. Click Fork and select your user account if needed:

"Forking" a GitHub repository means copying it to an identical repo under your GitHub account. When you fork woof-CE, you create your own personal copy of woof-CE.

  1. Go to https://github.dev/<your username>/woof-CE to open an online code editor very similar to Visual Studio Code

  2. Create a new branch and switch to it:

A branch is a series of commits, and commits are groups of code changes. Most often, a branch contains the set of changes needed to implement one feature or fix one issue.

"Switching" to a branch means that committed changes will be added to this branch, and not another.

  1. On the left, select a file and modify it:

  1. Save the file:

  1. In the Source Control pane, stage the changes:

"Staging" changes in a file means including these changes in the next commit. A commit is a unit of work, or a set of related changes. A commit can contain changes to more than one file.

  1. Repeat steps 6, 7 and 8 for every file you wish to modify.
  2. Type a short, clear and helpful commit message which describes the changes:

  1. Commit the changes:

Unstaged changes won't be included in the commit.

  1. Repeat steps 6 to 11 until all your changes are committed. Some changes are trivial and can be done in one commit (for example, a fix for a typo), but some big features require big changes, and they're easier to understand and test if they're implemented gradually, as a series of commits that represent sub-tasks and have descriptive commit messages.

  2. Your commits should now appear in your fork of woof-CE (make sure you select the right branch):

  1. When you wish to submit your changes for inclusion in woof-CE ("pull" into woof-CE), click the Create Pull Request button:

If you're unsure whether your changes break woof-CE, you can run woof-CE on GitHub and download an ISO image you can test.

  1. Type a descriptive pull request title and a description of the changes or additional information for reviewers, then click Create:

  1. Your pull request should now appear in https://github.com/puppylinux-woof-CE/woof-CE/pulls:

Other woof-CE developers will now be able to review your changes, discuss them, or merge ("pull") them into woof-CE.

If you want to do another contribution to woof-CE, repeat steps 4 to 16: create a new branch, do your changes, commit them and create another pull request.

Every pull request is associated with a specific branch, allowing you to work on multiple tasks at the same time.

  1. If you wish to push additional commits to the branch associated with a pull request (for example, to address concerns raised by reviewers), go to https://github.dev/<your username>/tree/<the branch name>:

The pull request associated with this branch always reflects the current state of the branch, and doesn't need to be closed and re-opened to include the new commits.

Add a custom footer
Add a custom sidebar
Clone this wiki locally