Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

31 lines (21 loc) · 1.83 KB
Raw

Contributing

Thank you for your interest in participating in the React Credit Cards project. We're happy to have you here.

NOTE: Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Reporting Bugs

Before creating bug reports, please check the issues as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible.

How to contribute?

  1. Fork this repo to your account then clone it to your environment.
  2. Run npm install to get things going.
  3. Replicate the issue you're trying to fix or spec out the feature you're trying to add. Understanding the scope of what you're fixing or adding is important and upfront thought helps.
  4. Change the code to fix the bug or add the feature. All changes should happen in the relevant *.jsx and *.scss files in the /src directory.
  5. Verify that your fix or feature works locally.
  6. Run npm run precommit to lint all the files and run the tests
  7. Run npm run build to bundle the production files.
  8. Commit your changes with an informative description. Do not make a single commit for big updates.
  9. Open a pull request to the primary repo with your new commits and a descriptive message about what the PR does.

Running the code locally

  • Download the demo source from codesandbox and install the dependencies
  • Link your local repo into the demo source code. Check npm-link for instructions.

What can I contribute?

Check out the issues for a comprehensive list of unfixed bugs and desired features.