System-End/github-readme-stats
1
0
Fork 0
mirror of https://github.com/System-End/github-readme-stats.git synced 2026-04-19 21:05:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix: CONTRIBUTING.md grammar (#1546)

Browse source 
* fix: CONTRIBUTING.md grammar

* docs: fix CONTRIBUTING grammar

Co-authored-by: rickstaa <rick.staa@outlook.com>
This commit is contained in:
Dalpat Rathore 2022-02-17 12:40:38 +05:30 • committed by GitHub
parent 20ace75271
commit 9ace031260
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 41 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

83
CONTRIBUTING.md
View file

@ -2,50 +2,49 @@
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a issue - Reporting an issue
- Discussing the current state of the code - Discussing the current state of the code
- Submitting a fix - Submitting a fix
- Proposing new features - Proposing new features
- Becoming a maintainer - Becoming a maintainer
## All Changes Happen Through Pull Requests ## All Changes Happen Through Pull Requests
Pull requests are the best way to propose changes. We actively welcome your pull requests: Pull requests are the best way to propose changes. We actively welcome your pull requests:
1. Fork the repo and create your branch from `master`. 1. Fork the repo and create your branch from `master`.
1. If you've added code that should be tested, add some tests' example. 2. If you've added code that should be tested, add some tests' examples.
1. If you've changed APIs, update the documentation. 3. If you've changed APIs, update the documentation.
1. Issue that pull request! 4. Issue that pull request!
## Under the hood of github-readme-stats ## Under the hood of github-readme-stats
Interested in diving deeper into understanding how github-readme-stats works? Interested in diving deeper into understanding how github-readme-stats works?
[Bohdan](https://github.com/Bogdan-Lyashenko) wrote an amazing in-depth post about it, check it out: [Bohdan](https://github.com/Bogdan-Lyashenko) wrote a fantastic in-depth post about it, check it out:
**[Under the hood of github-readme-stats project](https://codecrumbs.io/library/github-readme-stats)** **[Under the hood of github-readme-stats project](https://codecrumbs.io/library/github-readme-stats)**
## Local Development ## Local Development
To run & test github-readme-stats you need to follow few simple steps :- To run & test github-readme-stats, you need to follow a few simple steps:-
_(make sure you already have a [vercel](https://vercel.com/) account)_ _(make sure you already have a [Vercel](https://vercel.com/) account)_
1. Install [Vercel CLI](https://vercel.com/download) 1. Install [Vercel CLI](https://vercel.com/download)
1. Fork the repository and clone the code to your local machine 2. Fork the repository and clone the code to your local machine
1. Run `npm install` in the repository root 3. Run `npm install` in the repository root
1. Run the command "vercel" in the root and follow the steps there 4. Run the command "vercel" in the root and follow the steps there
1. Create a `.env` file in the root of the directory 5. Create a `.env` file in the root of the directory
1. In the .env file add a new variable named "PAT_1" with your [github Personal access token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) 6. In the .env file add a new variable named "PAT_1" with your [GitHub Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)
1. Run the command "vercel dev" to start a development server at https://localhost:3000 7. Run the command "vercel dev" to start a development server at <https://localhost:3000>
## Themes Contribution ## Themes Contribution
GitHub Readme Stats supports custom theming and you can also contribute new themes! GitHub Readme Stats supports custom theming, and you can also contribute new themes!
All you need to do is edit [themes/index.js](./themes/index.js) file and add your theme at the end of the file. All you need to do is edit the [themes/index.js](./themes/index.js) file and add your theme at the end of the file.
While creating the Pull request to add a new theme **don't forget to add a screenshot of how your theme looks**, you can also test how it looks using custom url parameters like `title_color`, `icon_color`, `bg_color`, `text_color`, `border_color` While creating the Pull request to add a new theme **don't forget to add a screenshot of how your theme looks**, you can also test how it looks using custom URL parameters like `title_color`, `icon_color`, `bg_color`, `text_color`, `border_color`
> NOTE: If you are contributing your theme just because you are using it personally, then you can [customize the looks](./readme.md#customization) of your card with URL params instead. > NOTE: If you are contributing your theme just because you are using it personally, then you can [customize the looks](./readme.md#customization) of your card with URL params instead.
@ -59,24 +58,24 @@ We use GitHub issues to track public bugs. Report a bug by [opening a new issue]
## Frequently Asked Questions (FAQs) ## Frequently Asked Questions (FAQs)
**Q:** How to hide jupyter Notebook? **Q:** How to hide Jupyter Notebook?
> **Ans:** &hide=jupyter%20notebook > **Ans:** &hide=jupyter%20notebook
**Q:** I could not figure out how to deploy on my own vercel instance **Q:** I could not figure out how to deploy on my own Vercel instance
> **Ans:** > **Ans:**
> >
> - docs: https://github.com/anuraghazra/github-readme-stats/#deploy-on-your-own-vercel-instance > - docs: <https://github.com/anuraghazra/github-readme-stats/#deploy-on-your-own-vercel-instance>
> - YT tutorial by codeSTACKr: https://www.youtube.com/watch?v=n6d4KHSKqGk&feature=youtu.be&t=107 > - YT tutorial by codeSTACKr: <https://www.youtube.com/watch?v=n6d4KHSKqGk&feature=youtu.be&t=107>
**Q:** Language Card is incorrect **Q:** Language Card is incorrect
> **Ans:** Please read all the related issues / comments before opening any issues regarding language card stats: > **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-665164174>
> >
> - https://github.com/anuraghazra/github-readme-stats/issues/136#issuecomment-665172181 > - <https://github.com/anuraghazra/github-readme-stats/issues/136#issuecomment-665172181>
**Q:** How to count private stats? **Q:** How to count private stats?
@ -86,14 +85,14 @@ We use GitHub issues to track public bugs. Report a bug by [opening a new issue]
**Great Bug Reports** tend to have: **Great Bug Reports** tend to have:
- A quick summary and/or background - A quick summary and/or background
- Steps to reproduce - Steps to reproduce
- Be specific! - Be specific!
- Share the snapshot, if possible. - Share the snapshot, if possible.
- GitHub Readme Stats' live link - GitHub Readme Stats' live link
- What actually happens - What actually happens
- What you expected would happen - What you expected would happen
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) - Notes (possibly including why you think this might be happening or stuff you tried that didn't work)
People _love_ thorough bug reports. I'm not even kidding. People _love_ thorough bug reports. I'm not even kidding.
@ -101,9 +100,9 @@ People _love_ thorough bug reports. I'm not even kidding.
**Great Feature Requests** tend to have: **Great Feature Requests** tend to have:
- A quick idea summary - A quick idea summary
- What & why you wanted to add the specific feature - What & why do you want to add the specific feature
- Additional Context like images, links to resources to implement the feature etc etc. - Additional context like images, links to resources to implement the feature, etc.
## License ## License