From b22e0a450106e09c65f7bcb0a542152b41fc4d48 Mon Sep 17 00:00:00 2001 From: sadrasabouri Date: Tue, 28 Sep 2021 15:27:44 +0330 Subject: [PATCH] add : CONTRIBUTING.md added. (#1) --- .github/CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..54be190 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,18 @@ +# Contribution + +Changes and improvements are more than welcome! ❤️ Feel free to fork and open a pull request. + +Please consider the following : + +1. Fork it! +2. Create your feature branch (under `dev` branch) +3. Add your new features or fix detected bugs +4. Add standard `docstring` to your functions +5. Update `README.md` (if needed) +6. Pass all CI tests +7. Update `CHANGELOG.md` + - Describe changes under `[Unreleased]` section +8. Update `AUTHORS.md` + - Add your name under `# Other Contributors #` section +9. Submit a pull request into `dev` (please complete the pull request template) +