Skip to content

Latest commit

 

History

History
115 lines (78 loc) · 4.04 KB

CONTRIBUTING.md

File metadata and controls

115 lines (78 loc) · 4.04 KB

Contributing to Sh**t! I Smoke

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

IMPORTANT You will need to sign a Contributor License Agreement

When you submit code changes, a Github bot checks that you correctly signed a Contributor License Agreement (or "CLA"). The CLA gives rights to your commit to us (the team at Sh**t! I Smoke), and we then release these changes be under the same GPL-3.0 License that covers the project. The terms of this CLA can be found here.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

People love thorough bug reports. I'm not even kidding.

Use a Consistent Coding Style

We use an opiniated eslint, which is configured to behave like prettier + @typescript-eslint/recommended.

Run yarn lint to make sure that your code passes linting. You can optionally add the --fix flag to let eslint automatically fix some errors.

There's two additional rule that are not (yet?) implemented in eslint: imports ordering & props/destructuring ordering. This is right now only enforced by PR reviewers.

Imports Ordering

The import ... from '...'; at the top of files follow some rules:

  • Absolute imports before relative imports
- import { Cigarettes } from './Cigarettes';
- import React from 'react';
+ import React from 'react';
+ import { Cigarettes } from './Cigarettes';
  • Absolute imports are sorted alphabetically by package name
- import { StackNavigation } from 'react-navigation';
- import React from 'react';
+ import React from 'react';
+ import { StackNavigation } from 'react-navigation';
  • Relative imports are reverse-sorted by import depth, meaning deeper imports appear first
- import { Cigarettes } from './Cigarettes';
- import { ApiContext }  from '../../stores';
+ import { ApiContext }  from '../../stores';
+ import { Cigarettes } from './Cigarettes';
  • Imports at the same depth are sorted alphabetically by module name
- import { Cigarettes } from './Cigarettes';
- import { Background }  from './Background';
+ import { Background }  from './Background';
+ import { Cigarettes } from './Cigarettes';

Props/Destructuring Ordering

  • Destructured fields are ordered alphabetically
- import { useState, useContext } from 'react';

- const { width, height } = props;

+ import { useContext, useState } from 'react';

+ const { height, width } = props;
  • Props in React components are ordered alphabetically
- <Cigarettes style={{ width: 30 }} cigarettes={2} />
+ <Cigarettes cigarettes={2} style={{ width: 30 }} />