Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (36 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

61 lines (36 loc) · 1.93 KB

Contributing to CardMesh

First off, thanks for taking the time to contribute! 🎉👍

Contributions, bug reports, and issues are very welcome. Open source is about collaboration, and we are always looking for more collaborators!

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

Reporting Bugs

If you find a bug, please feel free to open an issue. A good bug report has:

Suggesting Enhancements

We love to hear about new ideas! If you have a suggestion for improving the app, please open an issue.

Your First Code Contribution

If you're not sure where to start, look for issues tagged with 'good first issue'. These are usually small bugs or enhancements that have been specifically marked as friendly to people who are new to the codebase.

Pull Requests

  1. Fork the project, clone your fork, and configure the remotes
  2. Create a new topic branch (from the main branch) to contain your feature, change, or fix.
  3. Commit your changes in logical chunks. Make sure your commit messages are in the proper format.
  4. Push your topic branch up to your fork.
  5. Open a Pull Request with a clear title and description.

Setting Up Your Environment

  1. Clone the application

    git clone [email protected]:CardMesh/rest-api.git && cd rest-api

  2. Configure your private .env file, following the .env.example sample

  3. Run the app

    npm run dev # dev

    npm run build && npm run preview # dev

    npm run build && npm run start # prod

Running Tests

Run the tests with the following command:

npm run test

Please ensure that the tests all pass before you submit a Pull Request.

Thank you for contributing! 🎉