From e51f812003ff505e9a329f5e1704e7a7126fbe76 Mon Sep 17 00:00:00 2001 From: Supratim Date: Tue, 25 Oct 2022 12:57:48 +0530 Subject: [PATCH 1/3] Added contributing guidelines --- CONTRIBUTING.md | 28 ++++++++++++++++++++++++++++ README.md | 2 ++ 2 files changed, 30 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a433f76 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,28 @@ + +# Contributor guidelines + +If you are looking to help with a code contribution our project uses JavaScript. If you don't feel ready to make a code contribution yet, no problem! You can also check out the documentation issues or the design issues that we have. + +### How do I make a contribution? + +Never made an open source contribution before? Wondering how contributions work in the in our project? Here's a quick rundown! + +- Find an issue that you are interested in addressing or a feature that you would like to add. +- Fork the repository associated with the issue to your local GitHub organization. This means that you will have a copy of the repository under your-GitHub-username/repository-name. +- Clone the repository to your local machine. +``` +git clone https://github.com/github-username/passdom.git +``` +- Create a new branch for your fix using ``` git checkout -b branch-name-here ``` +- Make the appropriate changes for the issue you are trying to address or the feature that you want to add. +- Use ```git add insert-paths-of-changed-files-here``` to add the file contents of the changed files to the "snapshot" git uses to manage the state of the project, also known as the index. +- Use ```git commit -m "Insert a short message of the changes made here"``` to store the contents of the index with a descriptive message. +- Push the changes to the remote repository using ``` git push origin branch-name-here``` +- Submit a pull request to the upstream repository. +- Title the pull request with a short description of the changes made and the issue or bug number associated with your change. **For example, you can title an issue like so "Added more log outputting to resolve #4352".** +- In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It's OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it! +- Wait for the pull request to be reviewed by a maintainer. +- Make changes to the pull request if the reviewing maintainer recommends them. +- Celebrate your success after your pull request is merged! + + diff --git a/README.md b/README.md index 2ea551c..d184a74 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,8 @@ All the credentials are stored on your local computer, so any third party can't If you want to contribute, check out the GitHub repository https://github.com/zeel-pathak/passdom +[Contributing Guideline](/CONTRIBUTING.md) + Contributions are welcome!! ## Open Source 👐 From e3d272c5191725e91b0d7a3ec4f7b4bd0ea66392 Mon Sep 17 00:00:00 2001 From: Supratim Majumder <49454292+Supratim30@users.noreply.github.com> Date: Tue, 25 Oct 2022 12:59:21 +0530 Subject: [PATCH 2/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a433f76..f89ea94 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,7 @@ # Contributor guidelines -If you are looking to help with a code contribution our project uses JavaScript. If you don't feel ready to make a code contribution yet, no problem! You can also check out the documentation issues or the design issues that we have. +If you are looking to help with a code contribution our project uses **JavaScript**. If you don't feel ready to make a code contribution yet, no problem! You can also check out the documentation issues or the design issues that we have. ### How do I make a contribution? From 1827762b0509e219a791a12c94bf543e9cd5fb7d Mon Sep 17 00:00:00 2001 From: Supratim Majumder <49454292+Supratim30@users.noreply.github.com> Date: Tue, 25 Oct 2022 20:19:57 +0530 Subject: [PATCH 3/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f89ea94..e149266 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,28 +1,41 @@ # Contributor guidelines -If you are looking to help with a code contribution our project uses **JavaScript**. If you don't feel ready to make a code contribution yet, no problem! You can also check out the documentation issues or the design issues that we have. +If you are looking to help with a code contribution our project uses JavaScript. If you don't feel ready to make a code contribution yet, no problem! You can also check out the documentation issues or the design issues that we have. ### How do I make a contribution? Never made an open source contribution before? Wondering how contributions work in the in our project? Here's a quick rundown! - Find an issue that you are interested in addressing or a feature that you would like to add. + - Fork the repository associated with the issue to your local GitHub organization. This means that you will have a copy of the repository under your-GitHub-username/repository-name. + - Clone the repository to your local machine. ``` git clone https://github.com/github-username/passdom.git ``` - Create a new branch for your fix using ``` git checkout -b branch-name-here ``` + - Make the appropriate changes for the issue you are trying to address or the feature that you want to add. + - Use ```git add insert-paths-of-changed-files-here``` to add the file contents of the changed files to the "snapshot" git uses to manage the state of the project, also known as the index. + - Use ```git commit -m "Insert a short message of the changes made here"``` to store the contents of the index with a descriptive message. + - Push the changes to the remote repository using ``` git push origin branch-name-here``` + - Submit a pull request to the upstream repository. + - Title the pull request with a short description of the changes made and the issue or bug number associated with your change. **For example, you can title an issue like so "Added more log outputting to resolve #4352".** + - In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It's OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it! + - Wait for the pull request to be reviewed by a maintainer. + - Make changes to the pull request if the reviewing maintainer recommends them. -- Celebrate your success after your pull request is merged! +- Celebrate your success after your pull request is merged! +### What does the Code of Conduct mean for me? +Our Code of Conduct means that you are responsible for treating everyone on the project with respect and courtesy regardless of their identity. If you are the victim of any inappropriate behavior or comments as described in our Code of Conduct, we are here for you and will do the best to ensure that the abuser is reprimanded appropriately, per our code.