Skip to content

Latest commit

 

History

History
76 lines (50 loc) · 3.17 KB

CONTRIBUTING.md

File metadata and controls

76 lines (50 loc) · 3.17 KB
Raw

Contributing to @pplancq/dev-tools

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Put a star to the project
  • Share it on social media
  • Refer this project in your project's readme
  • Mention the project at local meetups and tell your friends/colleagues

Code of Conduct

This project and everyone participating in it is governed by the @pplancq/dev-tools Code of Conduct. By participating, you are expected to uphold this code.

I Have a Question

If you want to ask a question, we assume that you have read the available Documentation.

Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

  • Open an Issue.
  • Provide as much context as you can about what you're running into.
  • Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.

We will then take care of the issue as soon as possible.

How to contribute to this project?

  1. Fork the repository on GitHub
  2. Clone the fork on your local machine
  3. Commit the changes to your own branch, see the section on Commit conventions
  4. Push your work to your fork
  5. Submit a Pull request so we can review your proposal

Commit conventions

We follow the conventions of Conventional Commits. This means that the commit message must be structured as follows:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

For example:

feat(react-template): add a new feature
fix(webpack-config): fix a bug

Branch naming

Branch names should be prefixed with feature/ or bugfix/ depending on the type of work you're doing on the branch. For example, if you're working on a new authentication feature, you could name your branch feature/authentication.

How do I report a bug?

If you find a bug in the project :

  1. Search the project's issues to see if the bug has already been reported. If so, add a comment to the existing issue instead of creating a new one.
  2. If you can't find a matching issue, create a new one. Provide details about the bug, including steps to reproduce it, the impact of the bug and expected behavior.

Thank you for contributing to this project!