From 4ac53af497fe1edab61b5c92bdb61e1e3b519bd4 Mon Sep 17 00:00:00 2001 From: Ariful Alam Date: Sun, 20 Mar 2022 01:45:29 +0600 Subject: [PATCH 1/2] Add contributing guide --- CONTRIBUTING.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..bbc76cd --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,38 @@ +# Contributing + +👍🎉 First off, thanks for taking the time to contribute! 🎉👍 + +If you have found an issue or would like to request a new feature, simply create a new issue detailing the request. We also welcome pull requests. See below for information on getting started with development and submitting pull requests. + +Please note we have a [code of conduct](https://github.com/arifszn/ezprofile/blob/main/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project. + +## Found an Issue? + +If you find a bug in the source code or a mistake in the documentation, you can help us by +submitting an issue to our [GitHub Repository](https://github.com/arifszn/ezprofile/issues/new). Even better you can submit a Pull Request +with a fix. + +## Submitting a Pull Request + +- If applicable, update the `readme` +- Use `npm run lint` and `npm run prettier` before committing +- Example for a commit message + + ``` + Fix type validation for typescript + ``` + +### Developing + +Fork, then clone the repo: + +```sh +git clone https://github.com/your-username/ezprofile.git +cd ezprofile +``` + +Install dependencies: + +```sh +npm install +``` From 19243fde6a004bd6f98eb8de00eba85a055d759d Mon Sep 17 00:00:00 2001 From: Ariful Alam Date: Sun, 20 Mar 2022 01:46:39 +0600 Subject: [PATCH 2/2] Update Contribute section --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3bea3a2..2ab814a 100644 --- a/README.md +++ b/README.md @@ -396,9 +396,9 @@ I intend to keep my works open source. Please do not discourage me by claiming t Buy Me A Coffee -## 💡 Contributing +## 💡 Contribute -Any contributors who want to make this project better can make contributions, which will be greatly appreciated. To contribute, clone this repo locally and commit your code to a new branch. Feel free to create an issue or make a pull request. +To contribute, see the [Contributing guide](https://github.com/arifszn/ezprofile/blob/main/CONTRIBUTING.md). ## 📄 License