3.1 KiB
Contributing
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
Submitting a pull request
- Fork and clone the repository
- Configure and install the dependencies:
npm install - Make sure the tests pass on your machine:
npm test - Create a new branch:
git checkout -b my-branch-name - Make your change, add tests, and make sure the tests still pass
- Push to your fork and submit a pull request
- Pat your self on the back and wait for your pull request to be reviewed and merged.
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
- Follow the style guide which is a custom eslint linter.
- Write and update tests.
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
- Write a good commit message.
Work in Progress pull request are also welcome to get feedback early on, or if there is something blocked you.
Resources
Adding your app
You can add your app to the website by creating a new file in _apps/ with this template:
---
# A human-friendly name of your listing
title: Title of Your app
# A short description of what your app does
description: What your app does
# The slug of your hosted app on GitHub (https://github.com/apps/YOUR-SLUG)
slug: Shortened version of app name
# Include a few screenshots that show your app in action
screenshots:
- https://somewebsite.com/your-screenshot.png
# Your GitHub username
author: your-username
# The repository where the code is located
repository: your-username/your-app
---
Any documentation can go here. Many apps just use their README.md here.
Hosting your app
We will list un-hosted apps on the website to help gain more exposure. We will consider hosting apps on a case by case basis.
When considering hosting new plugins here's what we look for, the app:
- Works (ie it can run without errors and perform some sort of action on GitHub through the API)
- Does something not already done by an existing probot app
- Has minimal tests
- Has minimal documentation
- Is open source
- Has a license
- Has a code of conduct
- Has someone willing to at least minimally maintain them for the near future