Skip to content

Contributing

Development and Contributing

Issue

To make an improvement, add a new feature or anything else, please open a issue first.

Good first issues are the issues that you can quickly solve, we recommend you take a look. Good first issue

Fork Repository

fork the unimport.

Clone Repository

$ git clone git@github.com:<USERNAME>/unimport.git
$ cd unimport

Setup Branch

git checkout -b i{your issue number}

How to Update My Local Repository

$ git remote add upstream git@github.com:hakancelik96/unimport.git
$ git fetch upstream # or git fetch --all
$ git rebase upstream/master

Testing

Firstly make sure you have py3.6, py3.7, and py3.8 python versions installed on your system.

After typing your codes, you should run the tests by typing the following command.

$ python3.8 -m pip install tox
$ tox

If all tests pass.

The final step

After adding a new feature or fixing a bug please report your change to CHANGELOG.md and write your name, GitHub address, and email in the AUTHORS.md file in alphabetical order.

Commit Messages

If you want, you can use the emoji about the commit message you will throw, this can help us better understand the change you have made and also it is fun.

  • When you make any support commit; πŸ’ͺ
  • When you make any tests commit; πŸ§ͺ
  • When you make any fix commit; 🐞
  • When you make any optimization commit; πŸ’Š
  • when you make any new feature commit; πŸ”₯

License

Unimport is MIT licensed, as found in the LICENSE file.


Last update: June 26, 2021
Created: June 26, 2021