Skip to content

Latest commit

 

History

History
32 lines (21 loc) · 1.18 KB

CONTRIBUTING.MD

File metadata and controls

32 lines (21 loc) · 1.18 KB

Contributing

Loginradius Developer Docs is MIT licensed and accepts contributions via GitHub pull requests. This document outlines some of the conventions on development workflow, commit message formatting, contact points and other resources to make it easier to get your contribution accepted.

Getting Started

  • Fork the repository on GitHub
  • If you find any bug/typo/fix in our existing blog posts, please create a pull request as mentioned in Contribution Flow

Contribution Flow

  • Create a separate branch from dev branch to base your work.
  • Make commits of logical units.
  • Make sure your commit messages are in the proper format (see below).
  • Push your changes to a topic branch in your fork of the repository.
  • Make sure to proofread the content before submitting
  • Submit a pull request to the original repository.

Commit Messages

Please follow the below format while writing commit messages

  title: Title of the document
  tags: [<Related comma separated tags>]
  description: An optional description of your changes.
  path: "Path of the document under content folder"

Thanks for your contributions!