Skip to content

Latest commit

 

History

History
52 lines (39 loc) · 2.04 KB

CONTRIBUTING.md

File metadata and controls

52 lines (39 loc) · 2.04 KB
Raw

Contributing to creatives.lat

I love open-source 💛, so you are welcome to contribute if you want.

Development Requirements

Make sure you install all npm package for dev dependencies. You need to check prettier too.

This web was creates using create-react-app, so, you can start with: yarn start

Pull Requests

As I say, PR are welcome:

  1. Fork the repo and create your branch from master.
  2. Run npm -i -D after forking/cloning the repo.
  3. If you've added code that should be tested, add tests.
  4. If you've changed APIs, update the documentation.
  5. Ensure the test suite passes.
  6. Make sure your code lints.
  7. Keep in mind conflicts with master. Solve them.
  8. Make a commit message using the guidelines.

Commit Messages

As you can see, I like emojis 🌝. I inspire from WalmartLabs commit messages, so the guideline is:

  • ⭐ for commits related to adding new features.
  • 📦 for commits related to releases.
  • 🐛 for commits related to fixing broken code.
  • 📝 for commits related to adding and maintaining documentation.
  • ♻️ for commits related to refactoring code and making it work better.
  • 🛠 for commits related to writing or fixing tests.
  • 🌈 for commits related to making your code or your app beautiful with style changes.

A good commit log can look like this:

⭐️ explain the feature in one line

Body of commit message in a few lines of text...

Make sure you push a single commit.

Issues

I use GitHub issues to track public bugs. You can send me a twit if you want (@_toti1212). Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

Coding Style

I used prettier. Make sure your code is formatted with those before sending the pull request.

License

By contributing to creatives.lat, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree 🗣.