Merge pull request #58 from tomonarifeehan/markdown-update

documentation: updated-license-contribution-markdown

Contributing.md

@@ -1,17 +1,60 @@
-# Contributing
+## Contributing Guidelines
 
-When contributing to this repository, please try to contact me, Dario ([email protected]), to discuss the idea or change you're trying to implement. <br>
+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.<br/>
 
-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 ([email protected]), to discuss the idea or change you're trying to implement.<br/>
 
+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). 
+
+<br />
+
+## 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/<USERNAME>/repromodel.git
+```
+
+3. Navigate to project directory.
+```
+cd repromodel
+```
+
+4. Install dependencies.
+```
+npm install
+```
+
+5. Run.
+```
+npm run dev
+```
+
+<br />
 
 ## 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".
 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 a new branch for your update.
+```
+git checkout -b my-new-branch
+```
+3. Add and commit your code changes.
+```
+git add *
+git commit -m 'my-new-branch'
+```
+4. Push to the new branch.
+```
+git push origin my-new-branch
+```
+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
+
+For any help or questions, please open a new Github issue and we will get back to you :)

LICENSE → LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 dsitnik
+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
@@ -18,4 +18,4 @@ 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.
+SOFTWARE.

README.md

@@ -62,7 +62,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).
 
 <table>
   <tr>
@@ -100,7 +100,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 [email protected]
 
 ## License
-This project is licensed under the [MIT License](LICENSE).
+This project is licensed under the [MIT License](LICENSE.md).
 
 <br/>