Thank you for investing your time in contributing to our project! ✨.
Read our Code of Conduct to keep our community approachable and respectable.
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
Use the table of contents icon 
on the top left corner of this document to get to a specific section of this guide quickly.
To get an overview of the project, read the README.
Install requirements for contributing:
- Please install python3 on your system. (It is needed for scripts to format your commit messages and handle CHANGELOG.rst file)
- Install venv module for python (linux users only):
sudo apt-get install python3-venv
- Run this command in your terminal when you are in project directory:
python3 -m venv env
- Run
install.pyscript:./.githooks/install.py
- Bug: If you spot a problem with a certain release or a problem in develop branch, search if the issue already exists. If a related issue doesn't exist, you can open a new issue using Bug Report form in issue form section.
- Feature: If you want to add a new functionality to the project (which you can find new functionalities that we still don't support, in lodash documentation), or you have a feature idea of your own, first look up in issues and if a duplicate issue does not already exist, that means possibly (Take a look at Picking An Issue) no one is working on it and you can create a Feature Issue from issue form section.
If you just created an issue and you want to work on it by yourself, just mention it in the issue form that you handle it yourself or say it in comments.
If there is an issue in issues section that interests you, look up in issue description or comments if any one got the job and if not, you can write in the comments which you are working on it and that issue is yours for about a week after that.
After a week if you didn't create a pull request, anyone else can pick it up and that issue is not your's anymore.
Note: This workflow is designed based on git flow but please read till the end before doing anything.
- Pick or create a feature or bug issue.
- Fork the repository.
- Then you should create a branch:
- If you found a bug on a release branch, create a new branch based on that release branch with a name like:
bugfix/<issue number>
- If you found a bug on main branch, create a new branch based on main branch with a name like:
hotfix/<issue number>
- If you want to contribute a new feature into the project, create a new branch based on develop branch with a name like:
feature/<issue number>
- If you found a bug on a release branch, create a new branch based on that release branch with a name like:
- Make your changes locally.
- Test and debug your changes.
- Important: If you contributed a feature, make sure to write a test case and a benchmark for that new feature function.
- If you don't provide test case and benchmark functions for your new provided feature, we sadly can't accept your contribution.
- Add documentation for your new functions, interfaces and etc new things you added.
- If you are sure of your code, commit and push your changes (there are rules for commits in Commit message guidelines section, have a look)
- Create a pull request and mention your issue number inside the pull request.
- Wait for the review:
- We may ask you in review to add or change your code for a reason or mention you forgot to do something, If you provide the changes we asked, comeback and inform us about the changes and thanks for your contribution, we appreciate it. ✨
- If the review passed and pull request happened, thank you. we are happy to have you and between us. ✨
- If the review rejected, we will inform you about the reason for sure.
So in summary:
- Pick or create a feature or bug issue.
- Fork the repository.
- Create a new branch by what just said in number 3 of top list.
- Do the changes. (if you added new feature, don't forget to add test case and benchmark for that)
- Debug and be sure about the changes.
- Add documentation for new functions and variables and any other new things you provided.
- Commit and push your changes. (see commit message guidelines)
- Create a pull request and mention your issue number inside the pull request.
Never touch or change the file and let the script handle it.
There is a template for how to commit:
- <type>(<scope>): <subject>
Samples:
docs(changelog): update changelog to beta.5
- docs: Documentation only changes
- feat: A new feature
- fix: A bug fix
- perf: A code change that improves performance
- refactor: A code change that neither fixes a bug nor adds a feature
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- test: Adding missing tests or correcting existing tests
This section can be written in two formats:
- (<package>-<function>)
- (<file,description...>)
Note: If you don't specify this part, remove parenthesis too.
A brief description about what just happened.
This is just a reminder for us to know what versioning system we are using.
Versioning in this project is based on semantic versioning:
vMajor.Minor.Patch-PreReleaseIdentifier
Example:
- v1.4.0-beta.1
Signals backward-incompatible changes in a module’s public API. This release carries no guarantee that it will be backward compatible with preceding major versions.
Signals backward-compatible changes to the module’s public API. This release guarantees backward compatibility and stability.
Signals changes that don’t affect the module’s public API or its dependencies. This release guarantees backward compatibility and stability.
Signals that this is a pre-release milestone, such as an alpha or beta. This release carries no stability guarantees.
For more information about versioning, read this.