awesome-react-modules / react-pincode Goto Github PK

Currently, the city field displays district data from API end-point, which is inaccurate.
From the API end-point, we can add more fields-

Field : Parameter

Town/City : name
District : district
State : state

Where field is the displayed data and parameter are data from API.

The readme file had the same guidelines as the react-dark package so made the required changes. Corrected on on this PR.

Currently the module looks simple with minimal UI. But it can be made more presentable with certain enhancements.

I am a GSSOC participant and I would like to add CONTRIBUTING.md file to include the following mentioned features

• How to clone the repository
• Adding reference to the original repository
• Updating local copy of repository
• Creating a new branch
• Pushing commits
• If possible we can also include some pictures in it for a better look
• It should also include the link to the pull request template, bug report and feature request template
• Update README.md to include the link of CONTRIBUTING.md

As of now, when a wrong pincode is entered the input field turns red. There is no type check for various kind of wrong inpiuts. For example, a pincode must be of 6 digits. So if some number less than or greater than that is entered an alert should display.
Similarly if alphabets are entered then a specific alert should display for it as well and so on.

Since many people are still facing installation regarding issues, it will be great if we can a video for the same in the Readme.

A red tick will show up if the city and state details cannot be fetched. Otherwise a green one.

There is no Code of Conduct as of now. I have mentioned in one of the points in readme regarding it.
So can I make a file named Code of Conduct ?

Add issue template for the project.

Refer:

• https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository
• https://help.github.com/en/github/building-a-strong-community/manually-creating-a-single-issue-template-for-your-repository

Can I work on this, so that the participants can get a clear understanding of how to contribute to the website.

Addition of file to test the npm package for changes for GSSoC 2020.

Adding recent changes in the UI of the module not only adds classes on top of the minimal component but also makes it difficult to modify for users who are looking for a minimal design.

One proposed solution here can be to pass a prop with the component that informs the component whether the UI should be kept minimal or not. If yes then just drop the on-top classes and render a simple UI otherwise proper UI will be rendered.

This is one solution of the above problem. There are possible alternatives to it and it would be great if one can come up with them in the comments before asking for assigning up this issue.

Currently, the project is using the "Region" parameter of the response to fill the City field. The results will be more accurate if instead of "Region", the "District" parameter is used.

• The README is a long one. Adding a Table of Contents will make it easier for navigating through it.

Add pull request template for the repository
Refer:

• https://help.github.com/en/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository

Include fields like, Issue related, Demo Link, Screenshots, etc.

Is your feature request related to a problem? Please describe.
Google Maps can be added to the existing project for displaying the location of the query.

Describe the solution you'd like
A button would pop up on a valid Pincode input, which would redirect to a new webpage (Google Maps) showing the city generated from the query.

Additional context
Currently, no Google Maps API will be required.

The interface would look like this:

@plxity @yellowwoods12 @AdityaSrivast Please assign this issue to me.

Add appropriate actions to do the following tasks:

• Actions to detect stale issues and PR and give labels to them. ( Issue and PR which are unattended for long time)
• Auto Assign reviewers to PR created so they get notified about them.
• Detect any foul language/behaviour.

@plxity @yellowwoods12 Do you think it's a good idea to add these to the repo??