Skip to content

Latest commit

 

History

History
96 lines (66 loc) · 3.58 KB

CONTRIBUTING.md

File metadata and controls

96 lines (66 loc) · 3.58 KB

Contributing Guidelines

Welcome to the Imtjl organization on GitHub! We appreciate your interest in contributing to our community.

Getting Started

  1. First, make sure you have a GitHub account. If you don't, you can sign up here.
  2. Fork the repository you want to explore or contribute to.
    └ How to fork repository
          └ Why do you need to fork repo before cloning
  3. Clone the forked repository to your local machine.
    └ How to clone repository
  4. Create a new branch for your changes.
    └ How to set up a new branch

Making Changes

1. Make your changes in the new branch you created.
2. Test your changes thoroughly.
3. Commit your changes and write a clear and concise commit message.
4. Push your changes to your forked repository.

    └ Managing repository on your local machine

Commit messages

We use somewhat beautiful ✨ and outstanding 🚀 notation for commits! It would be familiar for those, who used conventional commits.

Commit message should be in the following format:

type[!] message

That is type optionally followed by exclamation mark, strictly followed by one space, followed by a message.

Total message length may exceed 80 characters (type is counted as one character), but it is recommended to make messages expressive and small.

Exclamation mark denotes breaking change. It is correlates with MAJOR in Semantic Versioning.

Type should be one of the following:

  • ✨ (:sparkles:) indicates new feature (analogue to feat tag in conventional commits)

  • 🔧 (:wrench:) improve or fix something (like somethis in between refactor and fix in conventional commits). Can be used interchangeably with 🐛 (:bug:)

  • 🐛 (:bug:) Indicates bug fix! More like fix in conventional commits

  • 📚 (:books:) Denotes work on documentation (analogue is doc from conventional commits)

  • 🔨 (:hammer:) General refactoring. Directory moves/additions/removals, project structure changes, work from ground up are all fall under this type

  • ♻️ (:recycle:) same as 🔨 (:hammer:)

  • 🚀 (:rocket:) Starting new great things (like new repository or subproject)!

  • 🗑️ (:wastebasket:) removing trash from repository like obsolete files

Examples

🐛 do not request auth token twice

✨ introduce commit message standard

📚 document that one class

♻️ rework request handler

Submitting Changes

1. Go to your forked repository on GitHub and create a pull request.
2. Describe your changes and why they are necessary in the pull request.
3. Wait for a member of the IMTJL organization to review your pull request.

    └ Creating pull request

Code of Conduct

  • Please note that we have a Code of Conduct that all contributors are expected to follow.
  • By participating in our community, you agree to abide by its terms.

Questions and Feedback

  • If you have any questions or feedback about contributing to Imtjl,
    feel free to start a discussion in our Github Discussions or contact us via our official email.

Thank you for your interest in contributing to Imtjl!