Contributing to GitHub Stats Extended

Local Development

To run and test GitHub-Stats-Extended, you need to follow a few simple steps:

make sure you have a Vercel account
Install Vercel CLI.
Fork the repository and clone the code to your local machine.
Run npm install in the repository root.
Run the command vercel in the root and follow the steps there.
Run the command vercel dev to start a development server at http://localhost:3000.
Create a .env file in the root and add the following line NODE_ENV=development, this will disable caching for local development.
The cards will then be available from this local endpoint (i.e. http://localhost:3000/api?username=anuraghazra).

Note

You can debug the package code in Vscode by using the Node.js: Attach to process debug option. You can also debug any tests using the VSCode Jest extension. For more information, see https://github.com/jest-community/vscode-jest/issues/912.

Themes Contribution

We have stopped the addition of new themes to decrease maintenance efforts. If you are considering contributing your theme just because you are using it personally, then instead of adding it to our theme collection, you can use card customization options.

Translations Contribution

GitHub-Stats-Extended supports multiple languages. If we are missing your language, you can contribute it! You can check the currently supported languages here.

To contribute your language you need to edit the backend/src/translations.js file and add a new property to each object where the key is the language code in ISO 639-1 standard and the value is the translated string.

Any contributions you make will be under the MIT Software License

In short, when you submit changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report issues/bugs using GitHub's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue. If there is already an open issue for your bug in the upstream repo github-readme-stats you don't need to report it here.

Frequently Asked Questions (FAQs)

Q: How to hide Jupyter Notebook?

Ans: &hide=jupyter%20notebook

Q: Language Card is incorrect

Ans: Please read all the related issues/comments before opening any issues regarding language card stats:

https://github.com/anuraghazra/github-readme-stats/issues/136#issuecomment-665164174

https://github.com/anuraghazra/github-readme-stats/issues/136#issuecomment-665172181

Q: How to count private stats?

Ans: We can only count public commits & we cannot access any other private info of any users, so it's not possible. The only way to count your personal private stats is to deploy on your own instance & use your own PAT (Personal Access Token)

Feature Request

Great Feature Requests tend to have:

A quick idea summary
What & why do you want to add the specific feature
Additional context like images, links to resources to implement the feature, etc.

3.7 KiB Raw Blame History