Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
108 lines (67 sloc) 3.58 KB

Contributing to Deity Falcon

First of all, thank you for taking the time to contribute! We embrace every commit, big or small.

The following is a set of guidelines for contributing to Deity Falcon. Please follow these guidelines as close as possible.

Code of Conduct

By participating in this project, you and everyone else is expected to uphold our Code of Conduct. Please report the unacceptable behavior to info@deity.io

If you have a question

Please don't file an issue to ask a question. You'll get faster results by using the resources below.

Official chat

Slack Community Channel

We also have an official message board with a detailed FAQ and where the community chimes in with helpful advice and answers if you have questions. (Coming soon)

Community Forum

How can I contribute?

If you'd like to contribute, start by searching through the issues and pull requests to see whether someone else has raised a similar idea or question.

Minor issues

Under minor issues we understand:

  • Typo fixes
  • Small formatting fixes
  • Adding/clearing non-trivial commented code

It is not necessary to create an issue for these; please create a pull request directly.

Reporting Bugs

Before reporting, please check if someone else has not already reported the same bug.

Please include the following in the report.

  • Steps to reproduce
  • Expected and actual result
  • Information of your environment
  • Be as specific as possible

Security vulnerabilities should be mailed directly to info@deity.io

Features/enhancements

New ideas and feature suggestions should be communicated first. Please use the community boards.

Conventional commits

Based on https://conventionalcommits.org/

<type>[optional scope]: <description>

[optional body]

[optional footer]
  • BREAKING CHANGE: - a commit that has the text BREAKING CHANGE: at the beginning of its optional body or footer section introduces a breaking API change (correlating with MAJOR in semantic versioning). A BREAKING CHANGE can be part of commits of any type.
  • fix: - a commit that patches a bug in your codebase (this correlates with PATCH in semantic versioning).
  • feat: - a commit that introduces a new feature to the codebase (this correlates with MINOR in semantic versioning).
  • improvement: - a commit that improves a current implementation without adding a new feature or fixing a bug
  • build: - a commit that with changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  • ci: - a commit that with changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
  • docs: - a commit that with changes documentation only changes
  • perf: - a commit with changes that improve performance
  • refactor: - a commit with changes that neither fixes a bug nor adds a feature
  • style: - a commit with that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)
  • test: - a commit to add missing tests or correcting existing tests

Examples

  • Commit message with description and breaking change in body:
feat: allow provided config object to extend other configs
BREAKING CHANGE:`extends`key in config file is now used for extending other config files
  • Commit message with no body:
docs: correct spelling of CHANGELOG
  • Commit message with scope:
feat(lang): added polish language
  • Commit message for a fix using an (optional) issue number:
fix: minor typos in code

see the issue for details on the typos fixed

fixes issue #12