From ebe343702454a77844b2325235dcd59584d0ddbd Mon Sep 17 00:00:00 2001 From: amitkumar-y Date: Tue, 11 Oct 2022 23:13:04 +0530 Subject: [PATCH] Added CONTRIBUTING.md file --- CONTRIBUTING.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..817496f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,60 @@ +# What do I need to know to help? + +If you are looking to help with a code contribution, our project uses C#. When contributing to this repository, please feel free to discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. + +## How do I make a contribution? + +If you've never made an open source contribution before or you are wondering how contributions work in our project? Here's a quick rundown! + +1. Fork the [repository](https://github.com/FireCubeStudios/FluentFlyouts3) to your account. This means that you will have a copy of the repository under `/`. +2. Clone the repository to your local machine using by copying the link provided under `HTTPS` when you click on the green button labeled `code` on the repository page + + ```sh + $ git clone https://github.com//FireCubeStudios/FluentFlyouts3.git + ``` + +4. Create a new branch for your changes or fix + + ```sh + $ git checkout -b + ``` + +5. Setup the project in your local by following the steps listed in the [README.md](https://github.com/FireCubeStudios/FluentFlyouts3/blob/master/README.md) file. +6. Open the project in a code editor and begin working on it. +7. Add the contents of the changed files to the "snapshot" git uses to manage the state of the project, also known as the index + + ```sh + $ git add . + ``` + +8. Add a descriptive commit message + + ```sh + $ git commit -m "Insert a short message of the changes made here" + ``` + +9. Push the changes to the remote repository + + ```sh + $ git push -u origin + ``` + +10. Submit a pull request to the upstream repository. +11. Title the pull request with a short description of the changes you made and **request a review from a maintainer/reviewer**. For example, you can title an issue like so "Added A New Windows 10 Specific Feature". In the description of the pull request, be sure to explain the changes that 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! +12. Wait for the pull request to be reviewed by a maintainer. +13. Make changes to the pull request if the reviewing maintainer recommends them. +14. Celebrate your success after your pull request is merged! 🎉 + +## Reviewer/Maintainers + + **GitHub**: [FireCube Studios](https://github.com/FireCubeStudios)
+ **Twitter**: [FireCube](https://twitter.com/FireCubeStudios)
+ **Linkedin**: https://www.linkedin.com/in/aaryan-arora-a956b8203/ + +## Where can I go for help? +- If you need help, you can ask questions directly in the pull request or issue. You can tag the reviewers/maintainers by typing '@' followed by their github username or just select from the dropdown option provided. + +## What does the Code of Conduct mean for me? +- Our [Code of Conduct](https://github.com/FireCubeStudios/.github/blob/master/code_of_conduct.md) 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. + +### Note: Portions of this `CONTRIBUTING.md` file are based off of Safia Abdalla's [A template for creating open source contributor guidelines](https://opensource.com/life/16/3/contributor-guidelines-template-and-tips) \ No newline at end of file