Git Product home page Git Product logo

hacktoberfest_progress's Introduction

Hacktoberfest Progress

Hacktoberfest progress is a chrome extension made to check your progress in the Hacktoberfest organised by DigitalOcean. It tells you how far you are from your goal and which of your Pull Requests were counted so far.

How to Contribute?

  • Fork the repository.
  • Comment on the issue which you want to solve so that there is no duplicate work. In case of duplicate work, comments will be used to decide which Pull Request to merge.
  • Create Pull Request.
  • Once you are a contributor, add yourselves to the contributors list as well as in the README file.

How to use?

Click here to get to the Chrome Web Store for the Hacktoberfest Progress Checker, chrome extension!

After installation, click on the extension icon on the right side of your address bar and then enter your Github username and then click on 'Check Progress'. You will get to see how many Pull Requests you have made and how many were accepted!

How to Run Tests

the project is now setup to have basic tests, and these tests will run on CircleCI.

to run the tests you must have some form of node pacakge manager(npm or yarn)

run:

yarn install

and then

yarn test

How to develop locally

Once you have cloned the project locally and are ready to begin developing. You can load the unpackaged files in developer tools, and point it at the local project.

https://developer.chrome.com/extensions/getstarted#manifest

If you make any changes then simply return to developer tools and refresh the extension to sync the changes made.

Contributors

Thanks goes to these wonderful people for their contributions:


Abhishek Deora

Duy Nguyen

Will Bray

Luke Taylor

Andreas Kleinbub

Bhavesh Gohel

Rafael Klaessen

Richard Robinson

Fredrik Mäkilä

Joseph Allen

hacktoberfest_progress's People

Contributors

adeora7 avatar aleksandarstojanovikj avatar ananthuanil13 avatar bhaveshgohel avatar ehnydeel avatar githug avatar jacksonisaac avatar jarcelao avatar joseph-allen avatar khemmapon avatar kincade71 avatar lmcjt37 avatar nelavensubas avatar pfinkbeiner avatar rafaelklaessen avatar raindogg avatar senthilraja112 avatar subinoy7 avatar zuik avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

hacktoberfest_progress's Issues

Fix broken 'how to use' URL

The URL is wrapped in a code block and not making it functionally clickable.

Needs fixing or restyling to keep it prominent.

Pull Request details as a popup

If the details of the Pull Requests in the results div can be showed as a popup only if someone clicks on a show details button, it will be better as now the length of the extension popup increases too much while displaying result.

403 error from GitHub

If 403 error returned when calling API, we should probably handle this better.

Suggestion: Don't change any UI unless a ~200 is returned successfully.

Improve the UI

Improve the UI in some way?

Make the results more prominent, improve the 'show results' overlay, better font?

Thumbnails for recent searchs

Thumbnails can be saved for at least 5 recently searched users for quick search. One option for design can be round images/handles right above the search box.

Progress bar bug

When you have reached over 5 PRs for the Hacktoberfest challenge, the bar appears to use the array index to set the length.

This means the bar extends outside the extension page container.

Solution: Fix the length of the progress bar to 5 segments max.

Search fails when user hasn't submitted PR within time range

Example response which causes error

{
"total_count": 0,
"incomplete_results": false,
"items": []
}

This errors as the avatar urls rely on user data being available and at least one PR existing.

Possible solution would be to have multiple calls to guarantee the user data is returned.

403 forbidden

When the limit is reached, a 403 forbidden error is thrown in the console.

We should handle this correctly by informing the user.

Active profile should have more prominence

The profile icon has been removed from below the buttons to improve the UI (#76)

Now the icons at the top are enlarged, but maybe the active profile icon should be larger than the unselected?

Saved last search result

Save the result of the last searched user in a single browser session so that every time a person opens the extension, it is not blank and shows the results related to the last searched GitHub Handle.

Add CI to run tests for PRs

Once tests have been created, we can add a CI (free) to run checks across new PRs.

I would recommend CircleCI as it's free to integrate.

Add contributors

Add contributors to readme file which are there in the contributors section of this repository.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.