Skip to content

Latest commit

 

History

History
65 lines (48 loc) · 3.71 KB

CONTRIBUTING.md

File metadata and controls

65 lines (48 loc) · 3.71 KB
Raw

Introduction

Hello!

First off, thank you for considering contributing to Active Admin. It's people like you that make Active Admin such a great tool.

[source: Active Admin] Need more inspiration? [1] Read The Docs [2] Mustache.js

Following the guidlines would be helpfull but not a must, just be nice and clear.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

[source: Hoodie]

Anything you can help with is gratefully accepted.

any piece of code is welcome, just adding simple documentation is welcome, but anything goes!

Little_Korean_Rice_Cooker is an open source project and we love to receive contributions from anyone — you! There are many ways to contribute, from writing tutorials, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into Little_Korean_Rice_Cooker itself.

Ground Rules

what i expect of you, and what you can expect from me.

Responsibilities

  • Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
  • Don't add any classes to the codebase unless absolutely needed. Err on the side of using functions.
  • Keep feature versions as small as possible, preferably one new feature per version.
  • Be welcoming to newcomers and encourage diverse new contributors from all backgrounds.

Getting started

how to contribute.

  1. Create your own fork of the code
  2. Do the changes in your fork
  3. If you like the change and think the project could use it:

small changes.

Small contributions such as fixing spelling errors, where the content is small enough to not be considered intellectual property, can be submitted by a contributor as a patch, without a CLA.

As a rule of thumb, changes are obvious fixes if they do not introduce any new functionality or creative thinking. As long as the change does not affect functionality, some likely examples include the following:

  • Spelling / grammar fixes
  • Typo correction, white space and formatting changes
  • Comment clean up
  • Bug fixes that change default return values or error codes stored in constants
  • Adding logging messages or debugging output
  • Changes to ‘metadata’ files like Gemfile, .gitignore, build scripts, etc.
  • Moving source files from one directory or package to another

How to report a bug

If you find a security vulnerability, do NOT open an issue. Email kasperbosteels@hotmail.com instead.

In order to determine whether you are dealing with a security issue, ask yourself these two questions:

  • Can I access something that's not mine, or something I shouldn't have access to?
  • Can I disable something for other people?

If the answer to either of those two questions are "yes", then you're probably dealing with a security issue. Note that even if you answer "no" to both questions, you may still be dealing with a security issue, so if you're unsure, just email us at security@travis-ci.org.

How to file a bug report.

When filing an issue, make sure to answer these five questions:

  1. What version of node are you using?
  2. What operating system and processor architecture are you using?
  3. What did you do?
  4. What did you expect to see?
  5. What did you see instead?