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 unexport.

Clone Repository¶

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

Setup Branch¶

git checkout -b i{your issue number}

How to Update My Local Repository¶

$ git remote add upstream git@github.com:hakancelikdev/unexport.git
$ git fetch upstream # or git fetch --all
$ git rebase upstream/main

Testing¶

Firstly make sure you have 3.8, 3.9 and 3.10 python versions installed on your system.

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

$ python3.9 -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¶

Unexport is GNU GENERAL PUBLIC licensed, as found in the LICENSE file.