Skip to content

Latest commit

 

History

History
129 lines (89 loc) · 9.13 KB

CONTRIBUTING.md

File metadata and controls

129 lines (89 loc) · 9.13 KB
Raw

Contributors

Submitting an Issue? See the Submitting Issues section in the README.

The process for contributions is roughly as follows:

Prerequisites

  • Ensure you have signed the Contributor License Agreement (CLA) - without this we are not able to take contributions that are not trivial.
  • Sign the Contributor License Agreement.
  • You must do this for each Chocolatey project that requires it.
  • If you are curious why we would require a CLA, we agree with Julien Ponge - take a look at his post.

Contributing Process

Get Buyoff Or Find Open Community Issues/Features

  • Through GitHub discussions you talk about a feature you would like to see (or a bug), and why it should be in Chocolatey GUI.
  • If approved, ensure the accompanying GitHub issue is created with information and a link back to the GitHub discussion.
  • Once you get a nod from one of the Chocolatey Team, you can start on the feature.
  • Alternatively, if a feature is on the issues list with the community tag, it is open for a patch. You should comment that you are signing up for it on the issue so someone else doesn't also sign up for the work.

Set Up Your Environment

  • You create, or update, a fork of chocolatey/chocolateygui under your GitHub account.
  • Clone the forked repo to your computer. git clone https://github.com/your-github/ChocolateyGUI.git
  • Set the remote upstream. git remote add upstream https://github.com/chocolatey/ChocolateyGUI.git
  • From there you create a branch named specific to the feature. git checkout -b feature-name
  • In the branch you do work specific to the feature.
  • Please also observe the following:
    • No reformatting
    • No changing files that are not specific to the feature
    • More covered below in the Prepare Commits section.
  • Test your changes and please help us out by updating and implementing some automated tests. It is recommended that all contributors spend some time looking over the tests in the source code. You can't go wrong emulating one of the existing tests and then changing it specific to the behavior you are testing.
  • Please do not update your branch from the master unless we ask you to. See the Respond to Feedback section below.

Prepare Commits

This section serves to help you understand what makes a good commit.

A commit should observe the following:

  • A commit is a small logical unit that represents a change.
  • Should include new or changed tests relevant to the changes you are making.
  • No unnecessary whitespace. Check for whitespace with git diff --check and git diff --cached --check before commit.
  • You can stage parts of a file for commit.

A commit message should observe the following:

  • The first line of the commit message should be a short description around 50 characters in length and be prefixed with the GitHub issue it refers to with parentheses surrounding that. If the GitHub issue is #25, you should have (#25) prefixed to the message. NOTE: Previously, the requirement was to use something like (GH-25) in commit messages, however, that approach has been deprecated.
  • If the commit is about documentation, the message should be prefixed with (doc).
  • If it is a trivial commit or one of formatting/spaces fixes, it should be prefixed with (maint).
  • After the subject, skip one line and fill out a body if the subject line is not informative enough.
  • The body:
    • Should indent at 72 characters.
    • Explains more fully the reason(s) for the change and contrasts with previous behavior.
    • Uses present tense. "Fix" versus "Fixed".

A good example of a commit message is as follows:

(#7) Installation Adds All Required Folders

Previously the installation script worked for the older version of
Chocolatey. It does not work similarly for the newer version of choco
due to location changes for the newer folders. Update the install
script to ensure all folder paths exist.

Without this change the install script will not fully install the new
choco client properly.

Submit Pull Request (PR)

Prerequisites:

  • You are making commits in a feature branch.
  • All specs should be passing.

Submitting PR:

  • Once you feel it is ready, submit the pull request to the chocolatey/chocolateygui repository against the develop branch (more information on this can be found here).
  • In the pull request, outline what you did and point to specific conversations (as in URLs) and issues that you are are resolving. This is a tremendous help for us in evaluation and acceptance.
  • Once the pull request is in, please do not delete the branch or close the pull request (unless something is wrong with it).
  • One of the Chocolatey Team members, or one of the committers, will evaluate it within a reasonable time period (which is to say usually within 2-4 weeks). Some things get evaluated faster or fast tracked. We are human and we have active lives outside of open source so don't fret if you haven't seen any activity on your pull request within a month or two. We don't have a Service Level Agreement (SLA) for pull requests. Just know that we will evaluate your pull request.

Respond to Feedback on Pull Request

We may have feedback for you to fix or change some things. We generally like to see that pushed against the same topic branch (it will automatically update the Pull Request). You can also fix/squash/rebase commits and push the same topic branch with --force. (It's generally acceptable to do this on topic branches not in the main repository. It is generally unacceptable and should be avoided at all costs against the main repository).

If we have comments or questions when we do evaluate it and receive no response, it will probably lessen the chance of getting accepted. Eventually this means it will be closed if it is not accepted. Please know this doesn't mean we don't value your contribution, just that things go stale. If in the future you want to pick it back up, feel free to address our concerns/questions/feedback and reopen the issue/open a new PR (referencing old one).

Sometimes we may need you to rebase your commit against the latest code before we can review it further. If this happens, you can do the following:

  • git fetch upstream (upstream would be the mainstream repo or chocolatey/chocolateygui in this case)
  • git checkout develop
  • git rebase upstream/develop
  • git checkout your-branch
  • git rebase develop
  • Fix any merge conflicts
  • git push origin your-branch (origin would be your GitHub repo or your-github-username/chocolateygui in this case). You may need to git push origin your-branch --force to get the commits pushed. This is generally acceptable with topic branches not in the mainstream repository.

The only reasons a pull request should be closed and resubmitted are as follows:

  • When the pull request is targeting the wrong branch (this doesn't happen as often).
  • When there are updates made to the original by someone other than the original contributor. Then the old branch is closed with a note on the newer branch this supersedes #github_number.

Testing

There are some barebones Pester tests used to test the very basic functionalities of chocolateyguicli. These require Pester version 5.3.1 or newer. They can be launched by running Invoke-Pester within the Tests directory of the repository.

It is not currently expected that these Pester tests are run before submitting a PR. Their purpose at the moment is to establish a base to build upon.

Debugging with Chocolatey library information

In order to debug Chocolatey GUI, you need Chocolatey.Lib referenced in the project to match the Chocolatey version installed locally on your system. The easiest way to do this is to run ./Update-DebugConfiguration.ps1 from the root of the repository.

⚠️ NOTE

You will need to have nuget.commandline installed for this script to work.

You will also want to not commit the changes this script makes to the .csproj and packages.config files. As such, if you're making changes that would modify any of these files, it is recommended to make those changes, commit, then run the ./Update-DebugConfiguration.ps1 script.

Other General Information

If you reformat code or hit core functionality without an approval from a person on the Chocolatey Team, it's likely that no matter how awesome it looks afterwards, it will probably not get accepted. Reformatting code makes it harder for us to evaluate exactly what was changed.

If you follow the guidelines we have above it will make evaluation and acceptance easy. If you stray from them it doesn't mean we are going to ignore your pull request, but it will make things harder for us. Harder for us roughly translates to a longer SLA for your pull request.