Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 1.97 KB

CONTRIBUTING.md

File metadata and controls

49 lines (33 loc) · 1.97 KB
Raw

Contributing Guidelines

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 own branch from front-end-portfolio.
  2. If you've changed APIs, update the documentation.
  3. Make sure your code lints.
  4. Every PR should accompany an issue.
  5. Make a relevant PR title and mention the issue in the description.
  6. Strictly follow the template provided.

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)

Use a Consistent Coding Style

  • 2 spaces for indentation rather than tabs
  • You can try running npm run lint for style unification

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft