From d8e84f1f0170becc0a66d83deb90fcf89612bf33 Mon Sep 17 00:00:00 2001 From: Neelima Mohanty <97789856+neelimagoogly@users.noreply.github.com> Date: Thu, 13 Jul 2023 10:45:28 +0530 Subject: [PATCH 1/3] Create Contribution.md I have created the contribution doc . @kshitijrajsharma , @omranlm and @petya-kangalova please review it. --- docs/Contribution.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 docs/Contribution.md diff --git a/docs/Contribution.md b/docs/Contribution.md new file mode 100644 index 00000000..ae598298 --- /dev/null +++ b/docs/Contribution.md @@ -0,0 +1,29 @@ +## :hugs: Welcome + +:+1::tada: First off, I'm really glad you're reading this, because we need volunteer developers to help improve the fAIr! :tada::+1: + +We welcome and encourage contributors of all skill levels and we are committed to making sure your participation is inclusive, enjoyable and rewarding. If you have never contributed to an open source project before, we are a good place to start and will make sure you are supported every step of the way. If you have **any** questions, please ask! + +There are many ways to contribute to this repo: + +## Testing + +Adding test cases, or simply testing out existing functionality. + +## Report bugs and suggest improvements + +The [issue queue](https://github.com/hotosm/fAIr/issues) is the best way to get started. There are issue templates for BUGs and FEATURES that you can use, or you can create your own. Once you have submitted an issue, it will be assigned one label out of the following [label categories](https://github.com/hotosm/fAIr/labels). If you are wondering where to start, you can filter by the GoodFirstIssue label. + +## Code contributions + +Create pull requests (PRs) for changes that you think are needed. We would really appreciate your help! + +## Documentation contributions + +Create pull requests (PRs) for changes that you think are needed to the documentation of fAIr.As of now you can find the documentation work at the [docs](https://github.com/hotosm/fAIr/tree/master/docs) directory. + + +## :handshake: Thank you + +Thank you very much in advance for your contributions!! Please ensure you refer to our [Code of Conduct](https://github.com/hotosm/fAIr/blob/master/docs/Code-of-Conduct.md). +If you've read the guidelines, but you are still not sure how to contribute on Github, please reach out to us via our Slack #geospatial-tech-and-innovation. From d8d80fcc81984540ff3ea829f90185ac5a7555ee Mon Sep 17 00:00:00 2001 From: Neelima Mohanty <97789856+neelimagoogly@users.noreply.github.com> Date: Mon, 17 Jul 2023 17:07:26 +0530 Subject: [PATCH 2/3] Update Contribution.md --- docs/Contribution.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Contribution.md b/docs/Contribution.md index ae598298..147d4d73 100644 --- a/docs/Contribution.md +++ b/docs/Contribution.md @@ -1,6 +1,6 @@ ## :hugs: Welcome -:+1::tada: First off, I'm really glad you're reading this, because we need volunteer developers to help improve the fAIr! :tada::+1: +:+1::tada: First off, we are really glad you're reading this, because we need volunteer developers to help improve the fAIr! :tada::+1: We welcome and encourage contributors of all skill levels and we are committed to making sure your participation is inclusive, enjoyable and rewarding. If you have never contributed to an open source project before, we are a good place to start and will make sure you are supported every step of the way. If you have **any** questions, please ask! @@ -16,7 +16,7 @@ The [issue queue](https://github.com/hotosm/fAIr/issues) is the best way to get ## Code contributions -Create pull requests (PRs) for changes that you think are needed. We would really appreciate your help! +Fork repo , Maintain your local changes on branch and Create pull requests (PRs) for changes that you think are needed. We would really appreciate your help! ## Documentation contributions From bdb27df52d6550d2242bc7703acb3354ebdf4336 Mon Sep 17 00:00:00 2001 From: Neelima Mohanty <97789856+neelimagoogly@users.noreply.github.com> Date: Mon, 17 Jul 2023 17:09:31 +0530 Subject: [PATCH 3/3] Update README.md --- frontend/README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/frontend/README.md b/frontend/README.md index b49e3bab..e03099e9 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -1,3 +1,5 @@ +# Frontend Deployment for Development + ![example workflow](https://github.com/omranlm/TDB/actions/workflows/frontend_build.yml/badge.svg) ## Getting Started @@ -11,10 +13,10 @@ This project is tested with Node v14.17.3 and Node v16.14.2 ### Create .env file inside root dir -Put your credentials inside .env by following .env [sample](https://github.com/omranlm/TDB/blob/main/frontend/.env%20sample) +Put your credentials inside .env by following .env [sample](https://github.com/omranlm/TDB/blob/main/frontend/.env%20sample) . ### Start development server `npm start` -#### Note : Build and Run Backend First before building frontend +#### Note : Build and Run Backend first by following [this](https://github.com/hotosm/fAIr/blob/master/backend/README.md) before building frontend .