Skip to content

CONTRIBUTING_GUIDELINES.md

Latest commit

 

History

History
102 lines (74 loc) · 3.91 KB

CONTRIBUTING_GUIDELINES.md

File metadata and controls

102 lines (74 loc) · 3.91 KB

Contributing to Elementique

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

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

Anything that can improve this project is accepted.

Note: Please make sure you are not creating repeated issues and doing anything that is not in favour of the project.

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 main.
  2. If you've added code that should be tested, add tests.
  3. Ensure the test suite passes.
  4. Make sure your code lints.
  5. Issue that pull request!

Setup the project

# Clone your repository
$ git clone REPO_LINK

# Go into the repository
$ cd FOLDER_NAME

# Install dependencies
$ npm install

# Run storybook
$ npm run storybook

# Build the project
$ npm run build

Contribute

First make some major changes into the project and write test cases for that.

# Create a new branch
$ git checkout -b BRANCH_NAME

# Commit the changes
$ git add .
$ git commit -am "message"

# push to your repo on your branch
$ git push --set-upstream BRANCH_NAME

After following all these steps create a Pull Request and wait for it to get merged.

Directory Structure

  • dist: This contains the built package
  • src
    • components: this contains all the components that are available in the package
      • docs: all the files related to storybook are kept here
      • test: test cases are written here
    • utils: utilities used for our components

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

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

This is an example of a bug report I wrote, and I think it's not a bad model. Here's another example from Craig Hockenberry, an app developer whom I greatly respect.

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can. My stackoverflow question includes sample code that anyone with a base R setup can run to reproduce what I was seeing
  • 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

I'm again borrowing these from Facebook's Guidelines

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

License

By contributing, you agree that your contributions will be licensed under its MIT License.

References

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