Skip to content

Latest commit

 

History

History
36 lines (26 loc) · 1.66 KB

File metadata and controls

36 lines (26 loc) · 1.66 KB

Contributing

Issues

If you found a problem or something that could be improved, the opening of an Issue reporting the case will be welcome in the bug report. Before that, please check that one is not already reporting the same issue.

Pull Requests

If you want to contribute to the repository, here is a quick guide:

  1. Fork the repository
  2. Develop and test your code
    • Your code, at a minimum, must successfully build on Github Actions (When enabled)
  3. Commit your changes:
    • Use clear messages to document your commit
    • Include an Emoji de at the beginning of the pull request message that conforms to the emoji table. See the appropriate Emojis
  4. Push to your fork and then send a pull request to the dev branch

Emojis

When creating or updating the pull request message, please start the commit message with the emoji that identifies the pull request. Emojis should not be used in the pull request title. Emojis can also be used in commits.

  • 🆕 :new: when adding new functionality
  • 🐛 :bug: when fixing a bug
  • 📝 :memo: when adding documentation to the project
  • 🎨 :art: when improving the project structure
  • 🔥 :fire: when to remove files or codes
  • 🐎 :racehorse: when to improve performance
  • :white_check_mark: when to add tests
  • 💚 :green_heart: when to fix CI build error
  • 🔒 :lock: when to develop a security feature

Supporting Readings