Skip to content

Latest commit

 

History

History
84 lines (63 loc) · 3.59 KB

CONTRIBUTING.md

File metadata and controls

84 lines (63 loc) · 3.59 KB
Raw

How to contribute

First off, thanks for you interest in contributing. Everyone who uses this repos really appreciates it.

alt text

Issues

All are welcome.

Pull Requests

Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits. If your contribution involves a significant amount of work or substantial changes to any part of the project, please open an issue to discuss it first.

Make sure to adhere to the coding conventions used throughout a project (indentation, accurate comments, etc.). Please update any documentation that is relevant to the change you're making.

Pull Request Checklist

Before you submit your PR please make sure everything is in order.

  • Installed .alfredworkflow file from repo before making changes.

  • Update the version in the workflow title. Double-click the workflow to edit.

  • Increase the version number in update.json. Right-click the workflow in Alfred, click Show in Finder. The update.json file will be in that folder.

  • Increase the version number in current-version.json.

  • If needed include a large icon in the src/icon-src/ folder that has square dimensions.

  • If needed include a cached icon in the sec/icon-cache/ folder that 256x256 pixels. Alfred creates these when you insert an image into a workflow. You can get this from inside the .alfredworkflow. Right-click the workflow in Alfred, click Show in Finder. The --hash-value--.png file will be in that folder. Copy to /src/icon-cache and rename.

  • If needed add a screenshot. Use ⌘ (command) + ⇧ (shift) + 4, press ␣ (space), then click on the Alfred window to create a clean screen shot. Place in the screenshots folder.

  • Update README.md with new version and any additional screenshots.

  • Export workflow to repo folder. Right-click the workflow in Alfred, click Export.... Don't include the (v1.0) in the name.

Pull Request Process

Please follow this process; it's the best way to get your work included in the project:

  1. Fork the project, clone your fork, and configure the remotes:

    # Clones your fork of the repo into the current directory in terminal
git clone https://github.com/<your-username>/<this-repo-name>.git
# Navigate to the newly cloned directory
cd <folder-name>
# Assigns the original repo to a remote called "upstream"
git remote add upstream https://github.com/<this-username>/<this-repo-name>.git

  2. If you cloned a while ago, get the latest changes from upstream:

    git checkout master
git pull upstream master

  3. Create a new topic branch to contain your feature, change, or fix:

    git checkout -b <topic-branch-name>

  4. Commit your changes in logical chunks. Please adhere to these git commit message guidelines or your pull request is unlikely be merged into the main project. Use git's interactive rebase feature to tidy up your commits before making them public.

  5. Locally merge (or rebase) the upstream development branch into your topic branch:

    git pull [--rebase] upstream master

  6. Push your topic branch up to your fork:

    git push origin <topic-branch-name>

  7. Open a Pull Request with a clear title and description.