From c8e0dbd43a58fd9c17107c106a2918cf1b3cf621 Mon Sep 17 00:00:00 2001 From: tomonarifeehan Date: Mon, 27 May 2024 13:30:52 -0400 Subject: [PATCH 1/7] updated license and contributing markdown files --- LICENSE.md | 21 +++++++++++++++++++++ README.md | 4 ++-- 2 files changed, 23 insertions(+), 2 deletions(-) create mode 100644 LICENSE.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..b5912fc --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) ReproModel + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index 93d3b9d..88536fd 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ npm run dev ## Contributing Contributions are what make the open-source community such an amazing place to learn, inspire, and create. -Any contributions you make are greatly appreciated. If you have a suggestion that would make this better, please read our [Contribution Guidelines](Contributing.md) and [Code of Conduct](CODE_OF_CONDUCT.md). +Any contributions you make are greatly appreciated. If you have a suggestion that would make this better, please read our [Contribution Guidelines](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md). @@ -101,7 +101,7 @@ Any contributions you make are greatly appreciated. If you have a suggestion tha For questions or any type of support, you can reach out to me via dario.sitnik@gmail.com ## License -This project is licensed under the [MIT License](LICENSE). +This project is licensed under the [MIT License](LICENSE.md).
From 9771e12987d308310787cedfe09ace159396ebda Mon Sep 17 00:00:00 2001 From: tomonarifeehan Date: Mon, 27 May 2024 13:32:42 -0400 Subject: [PATCH 2/7] updated license and contributing markdown files --- Contributing.md | 37 ++++++++++++++++++++++++++++++++++--- LICENSE | 21 --------------------- 2 files changed, 34 insertions(+), 24 deletions(-) delete mode 100644 LICENSE diff --git a/Contributing.md b/Contributing.md index 06636c3..e31ed2b 100644 --- a/Contributing.md +++ b/Contributing.md @@ -1,9 +1,36 @@ -# Contributing +## Contributing Guidelines -When contributing to this repository, please try to contact me, Dario (dario.sitnik@gmail.com), to discuss the idea or change you're trying to implement.
+First of all, thanks for your interest in supporting this project! We could use all the help we can get to make the best possible experience for our community.
-Every contribution is welcome, no matter how simple or sophisticated it may be, as long as it adheres to the project's Code of Conduct. +When contributing to this repository, please try to contact me, Dario (dario.sitnik@gmail.com), to discuss the idea or change you're trying to implement.
+Every contribution is welcome, no matter how simple or sophisticated it may be, as long as it adheres to the project's [Code of Conduct](CODE_OF_CONDUCT.md). + +## How to Install Locally + +1. Fork this repo. + +You can fork this repo by [clicking here](https://github.com/ReproModel/repromodel/fork) + +2. Clone on your local machine. +``` +git clone https://github.com//repromodel.git +``` + +3. Navigate to project directory. +``` +cd repromodel +``` + +4. Install dependencies. +``` +npm install +``` + +5. Run. +``` +npm run dev +``` ## Pull Request Process @@ -15,3 +42,7 @@ Don't forget to give the project a star! Thanks again! 3. Commit your Changes (`git commit -m 'Enhancing ReproModel'`) 4. Push to the Branch (`git push origin feature/ReproModel`) 5. Open a Pull Request + +## Ask For Help + +For any help or questions, please open a new Github issue and we will get back to you :) \ No newline at end of file diff --git a/LICENSE b/LICENSE deleted file mode 100644 index bb280df..0000000 --- a/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2024 dsitnik - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. From 7efdd9fb7e707f67516777ec23fec7b48777440d Mon Sep 17 00:00:00 2001 From: tomonarifeehan Date: Mon, 27 May 2024 13:33:52 -0400 Subject: [PATCH 3/7] updated license and contributing markdown files --- Contributing.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/Contributing.md b/Contributing.md index e31ed2b..49be503 100644 --- a/Contributing.md +++ b/Contributing.md @@ -8,9 +8,7 @@ Every contribution is welcome, no matter how simple or sophisticated it may be, ## How to Install Locally -1. Fork this repo. - -You can fork this repo by [clicking here](https://github.com/ReproModel/repromodel/fork) +1. Fork this repo. You can fork this repo by [clicking here](https://github.com/ReproModel/repromodel/fork) 2. Clone on your local machine. ``` From 1553668995fccc6235fe38c009480944c8de1bd8 Mon Sep 17 00:00:00 2001 From: tomonarifeehan Date: Mon, 27 May 2024 13:38:37 -0400 Subject: [PATCH 4/7] updated license and contributing markdown files --- Contributing.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/Contributing.md b/Contributing.md index 49be503..3850d82 100644 --- a/Contributing.md +++ b/Contributing.md @@ -35,11 +35,21 @@ npm run dev If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again! -1. Fork the Project -2. Create your Feature Branch (`git checkout -b feature/ReproModel`) -3. Commit your Changes (`git commit -m 'Enhancing ReproModel'`) -4. Push to the Branch (`git push origin feature/ReproModel`) -5. Open a Pull Request +1. Fork the project. +2. Create your feature branch. +``` +git checkout -b my-new-branch +``` +3. Add and commit your changes. +``` +git add * +git commit -m 'my-new-branch' +``` +4. Push to the branch. +``` +git push origin my-new-branch +``` +5. Open a pull request from your forked repo to the main repo [here](https://github.com/ReproModel/repromodel/compare). ## Ask For Help From 726d83ef61078136572c053416bf67b2376b770c Mon Sep 17 00:00:00 2001 From: tomonarifeehan Date: Mon, 27 May 2024 13:39:13 -0400 Subject: [PATCH 5/7] updated license and contributing markdown files --- Contributing.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Contributing.md b/Contributing.md index 3850d82..afb075b 100644 --- a/Contributing.md +++ b/Contributing.md @@ -6,6 +6,8 @@ When contributing to this repository, please try to contact me, Dario (dario.sit Every contribution is welcome, no matter how simple or sophisticated it may be, as long as it adheres to the project's [Code of Conduct](CODE_OF_CONDUCT.md). +
+ ## How to Install Locally 1. Fork this repo. You can fork this repo by [clicking here](https://github.com/ReproModel/repromodel/fork) @@ -30,6 +32,8 @@ npm install npm run dev ``` +
+ ## Pull Request Process If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". From 268b9ce57fe2394f4d4bb9d88512c78167f303eb Mon Sep 17 00:00:00 2001 From: tomonarifeehan Date: Mon, 27 May 2024 13:40:36 -0400 Subject: [PATCH 6/7] updated license and contributing markdown files --- Contributing.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Contributing.md b/Contributing.md index afb075b..21b9b9e 100644 --- a/Contributing.md +++ b/Contributing.md @@ -40,16 +40,16 @@ If you have a suggestion that would make this better, please fork the repo and c Don't forget to give the project a star! Thanks again! 1. Fork the project. -2. Create your feature branch. +2. Create a new branch for your update. ``` git checkout -b my-new-branch ``` -3. Add and commit your changes. +3. Add and commit your code changes. ``` git add * git commit -m 'my-new-branch' ``` -4. Push to the branch. +4. Push to the new branch. ``` git push origin my-new-branch ``` From 2f80cb3004105a6f87cbc2ec88e9fe27a8884b2c Mon Sep 17 00:00:00 2001 From: tomonarifeehan Date: Mon, 27 May 2024 13:41:28 -0400 Subject: [PATCH 7/7] updated license and contributing markdown files --- Contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Contributing.md b/Contributing.md index 21b9b9e..660cdf5 100644 --- a/Contributing.md +++ b/Contributing.md @@ -53,7 +53,7 @@ git commit -m 'my-new-branch' ``` git push origin my-new-branch ``` -5. Open a pull request from your forked repo to the main repo [here](https://github.com/ReproModel/repromodel/compare). +5. Once done, open a pull request from your forked repo to the main repo [here](https://github.com/ReproModel/repromodel/compare). ## Ask For Help