Skip to content

Latest commit

 

History

History
88 lines (63 loc) · 4.88 KB

CONTRIBUTING.md

File metadata and controls

88 lines (63 loc) · 4.88 KB
Raw

Contributing to MTProto

based on Xelaj styleguides.

english русский

🌚🌚 First of all, thanks for your helping! 🌝🌝

This page briefly describes the process of developing both the specific MTProto package and all Xelaj projects. if you read all these rules, you will be the best helper in the westland!

Code of conduct

We all want to make other people happy! We believe that you are a good guy, but please, just in case, read our code of conduct. They will help you understand what ideals we adhere to, among other things, you will be even more cool!

By joining our community, you automatically agree to our rules (even if you have not read them!). and if you saw their violation somewhere, write to [email protected], we will help!

I don't want to read anything, I have a question!

Just remind: you just don’t need to ask anything right to the issues, okay? just not necessary. you will quickly solve your problem if you find the answer below

We have the official Xelaj chat in Telegram: @xelaj_developers. In this chat you can promptly clarify the information of interest to you.

Also, github create discussions page! Ask in discussions, that's why this feature released. It's like stack overflow for any repo like this one!

And we also actually want to do FAQ, but we don’t know what questions to write there, so, if you are reading this, probably write while in the Telegram, we'll figure it out :)

What do I need to know before I can help?

¯\_(ツ)_/¯

And how can I help?

For example, report a bug.

before reporting a bug:

  • Look for issues with a bug / bug label, it is likely that it has already been reported.
  • even if you found issue: describe your situation in the comments of issue, attach logs, backup database, just do not duplicate issues.

You can still offer a new feature:

We love to add new features! Use the New Feature issues template and fill in all the fields. Attaching labels is also very important!

and you can immediately offer a pull request!

Here it is up to you, the only thing is: we are more willing to take pull requests based on a specific issue (i.e., created pull request based on issue #100500 or something like this) This will help us understand what problem your request solves.

Styleguide

commit comments

  • do not write what commits do (❌ — commit adds ... ✅ — added support ...)
  • do not write who made a commit (❌ — I changed ... ❌ — our team worked for a long time and created ...)
  • write briefly (no more than 60 characters), everything else - in the description after two (2) new lines
  • pour all your misery into the commit description, not the comment (❌ — fool, forgot to delete ... ✅ — removed ...)
  • use prefixes, damn it! in general, we love emoji, so attach emoji: (btw, please use unicode emojis)
    • ⚡ :zap: Improve performance.
    • 🔥 :fire: Remove (irrevocably!) code or files.
    • 🐛 :bug: Fix a bug.
    • 🚑 :ambulance: Critical hotfix.
    • ✨ :sparkles: Introduce new features.
    • ✅ :white_check_mark: Add or update tests.
    • 🔒 :lock: Fix security issues.
    • 🚨 :rotating_light: Fix compiler/linter warnings.
    • 💚 :green_heart: Fix CI Build.
    • 👷 :construction_worker: Add or update CI build system.
    • 🎨 :art: Improve structure/format of the code.
    • 🏇 :racehorse: Refactor code. (miscellaneous refactoring)
    • 🔨 :hammer: Add or update development scripts.
    • ✏️ :pencil2: Fix typos.
    • ⏪ :rewind:Revert changes.
    • 🔀 :twisted_rightwards_arrows: Merge commits.
    • 👽 :alien:Update code due to external API changes.
    • 📝 :memo: Add or update documentation.
    • 📄 :page_facing_up: Add or update license. (that's different to docs)
    • 💡 :bulb: Add or update comments in source code.
    • 🍻 :beers: Write code drunkenly.
    • 👥 :busts_in_silhouette: Add or update contributor(s).
    • 🚸 :children_crossing: Improve user experience/usability.
    • 🏗 :building_construction: Make architectural changes.
    • 🤡 :clown_face: Mock things.
    • 🥚 :egg: Add or update an easter egg.
    • 🙈 :see_no_evil: Add or update a .gitignore file.
    • ⚗ :alembic: Perform experiments.
    • 🔍 :mag: Improve SEO. (seo of repository, not project)
    • 🗑 :wastebasket: Deprecate code that needs to be cleaned up.
    • 🩹 :adhesive_bandage: Simple fix for a non-critical issue.
    • 🧐 :monocle_face: Data exploration/inspection. (means that you explore anything and write docs)