Skip to content

Latest commit

 

History

History
84 lines (64 loc) · 3.43 KB

CONTRIBUTING.md

File metadata and controls

84 lines (64 loc) · 3.43 KB
Raw

Contributing to CodeGate

First off, thank you for taking the time to contribute to CodeGate! 👍 🎉 CodeGate is released under the Apache 2.0 license. If you would like to contribute something or want to hack on the code, this document should help you get started. You can find some hints for starting development in CodeGate's README.

Table of contents

Code of conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Reporting security vulnerabilities

If you think you have found a security vulnerability in CodeGate please DO NOT disclose it publicly until we've had a chance to fix it. Please don't report security vulnerabilities using GitHub issues; instead, please follow this process

How to contribute

Using GitHub Issues

We use GitHub issues to track bugs and enhancements. If you have a general usage question, please ask in CodeGate's discussion forum.

If you are reporting a bug, please help to speed up problem diagnosis by providing as much information as possible. Ideally, that would include a small sample project that reproduces the problem.

Not sure how to start contributing?

PRs to resolve existing issues are greatly appreciated and issues labeled as "good first issue" are a great place to start!

Pull request process

  • Create an issue outlining the fix or feature.
  • Fork the CodeGate repository to your own GitHub account and clone it locally.
  • Hack on your changes.
  • Correctly format your commit messages, see Commit message guidelines below.
  • Open a PR by ensuring the title and its description reflect the content of the PR.
  • Ensure that CI passes, if it fails, fix the failures.
  • Every pull request requires a review from the core CodeGate team before merging.
  • Once approved, all of your commits will be squashed into a single commit with your PR title.

Contributing to docs

Follow this guide for instructions on building, running, and previewing CodeGate's documentation.

Commit message guidelines

We follow the commit formatting recommendations found on Chris Beams' How to Write a Git Commit Message article:

  1. Separate subject from body with a blank line
  2. Limit the subject line to 50 characters
  3. Capitalize the subject line
  4. Do not end the subject line with a period
  5. Use the imperative mood in the subject line
  6. Use the body to explain what and why vs. how