mirror of
https://github.com/IonicaBizau/git-stats.git
synced 2025-03-24 09:18:20 +01:00
⬆️ 3.2.1 🎉
This commit is contained in:
Ionică Bizău
parent
37a52373f7
commit
b115995ae4
4 changed files with 26 additions and 26 deletions
|
|
@ -1,20 +1,17 @@
|
|||
# Contributing :star: :star2: :dizzy:
|
||||
# 🌟 Contributing
|
||||
|
||||
So, you want to contribute to this project? That's awesome! However, before doing so, please read the following simple steps on how to contribute. This will make life easier and avoid wasting time on things that are not requested. ✨
|
||||
Want to contribute to this project? Great! Please read these quick steps to streamline the process and avoid unnecessary tasks. ✨
|
||||
|
||||
## Discuss the changes before making them
|
||||
To begin, open an issue in the repository using the [bug tracker][1]. Describe the contribution you'd like to make, the bug you've found, or any other ideas you have. This step will help us get you started on the right track.
|
||||
## 💬 Discuss Changes
|
||||
Start by opening an issue in the repository using the [bug tracker][1]. Describe your proposed contribution or the bug you've found. If relevant, include platform info and screenshots. 🖼️
|
||||
|
||||
If it is relevant, include platform and software information (e.g., operating system, Node.JS version, etc.) and screenshots to help us understand what you're experiencing.
|
||||
Wait for feedback before proceeding unless the fix is straightforward, like a typo. 📝
|
||||
|
||||
We recommend waiting for feedback before proceeding to the next steps. However, if the issue is clear, such as a typo, and the fix is simple, you can go ahead and fix it.
|
||||
## 🔧 Fixing Issues
|
||||
|
||||
## Fixing Issues
|
||||
Begin by forking the project to your own account, and create a branch for your fix, naming it either `some-great-feature` or `some-issue-fix`.
|
||||
Fork the project and create a branch for your fix, naming it `some-great-feature` or `some-issue-fix`. Commit changes while following the [code style][2]. If the project has tests, add one. ✅
|
||||
|
||||
Commit your changes to that branch, adhering to the [code style][2]. If the project includes tests (usually located in the `test` directory), we encourage you to add a test as well. :memo:
|
||||
|
||||
If the project includes a `package.json` or a `bower.json` file, add yourself to the `contributors` array (or `authors` in the case of `bower.json`). If the array doesn't exist, create it as shown below:
|
||||
If a `package.json` or `bower.json` exists, add yourself to the `contributors` array; create it if it doesn't. 🙌
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
@ -24,18 +21,16 @@ If the project includes a `package.json` or a `bower.json` file, add yourself to
|
|||
}
|
||||
```
|
||||
|
||||
## Creating a Pull Request
|
||||
Start by opening a pull request and make sure to reference the initial issue in the pull request message (e.g., *fixes #<your-issue-number>*). Provide a clear and descriptive title to help everyone understand what is being fixed or improved.
|
||||
## 📬 Creating a Pull Request
|
||||
Open a pull request and reference the initial issue (e.g., *fixes #<your-issue-number>*). Provide a clear title and consider adding visual aids for clarity. 📊
|
||||
|
||||
If applicable, consider adding screenshots, gifs, or any other visual aids that can make it easier to understand the changes you've made.
|
||||
## ⏳ Wait for Feedback
|
||||
Your contributions will be reviewed. If feedback is given, update your branch as needed, and the pull request will auto-update. 🔄
|
||||
|
||||
## Wait for Feedback
|
||||
Before accepting your contributions, we will review them. You may receive feedback regarding what needs to be addressed in your modified code. If so, simply continue making commits to your branch, and the pull request will be automatically updated.
|
||||
## 🎉 Everyone Is Happy!
|
||||
Your contributions will be merged, and everyone will appreciate your effort! 😄❤️
|
||||
|
||||
## Everyone Is Happy!
|
||||
Ultimately, your contributions will be merged, and everyone will be delighted! 😄 Contributions are more than welcome!
|
||||
|
||||
Thanks! :sweat_smile:
|
||||
Thanks! 🤩
|
||||
|
||||
[1]: /issues
|
||||
[2]: https://github.com/IonicaBizau/code-style
|
||||
[2]: https://github.com/IonicaBizau/code-style
|
||||
2
LICENSE
2
LICENSE
|
|
@ -1,6 +1,6 @@
|
|||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2015-23 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)
|
||||
Copyright (c) 2015-25 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@
|
|||
|
||||
# `$ git-stats`
|
||||
|
||||
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [](https://github.com/IonicaBizau/ama) [](https://www.npmjs.com/package/git-stats) [](https://www.npmjs.com/package/git-stats) [](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
|
||||
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [](https://github.com/IonicaBizau/ama) [](https://www.npmjs.com/package/git-stats) [](https://www.npmjs.com/package/git-stats) [](https://www.codementor.io/@johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
|
||||
|
||||
<a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>
|
||||
|
||||
|
|
@ -41,7 +41,7 @@
|
|||
|
||||
I'd be curious to see your calendar with all your commits. Ping me on Twitter ([**@IonicaBizau**](https://twitter.com/IonicaBizau)). :smile: Until then, here's my calendar:
|
||||
|
||||
|
||||
|
||||
|
||||
## Contents
|
||||
|
||||
|
|
@ -326,6 +326,7 @@ g1.ansiCalendar({
|
|||
|
||||
|
||||
|
||||
|
||||
## :question: Get Help
|
||||
|
||||
There are few ways to get help:
|
||||
|
|
@ -340,6 +341,8 @@ There are few ways to get help:
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
## :memo: Documentation
|
||||
|
||||
For full API reference, see the [DOCUMENTATION.md][docs] file.
|
||||
|
|
@ -400,8 +403,8 @@ Thanks! :heart:
|
|||
## :dizzy: Where is this library used?
|
||||
If you are using this library in one of your projects, add it in this list. :sparkles:
|
||||
|
||||
- `git-stats-importer`
|
||||
- `git-stats-fcc-importer`
|
||||
- `git-stats-importer`
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
"git-stats": "bin/git-stats"
|
||||
},
|
||||
"name": "git-stats",
|
||||
"version": "3.2.0",
|
||||
"version": "3.2.1",
|
||||
"description": "Local git statistics including GitHub-like contributions calendars.",
|
||||
"main": "lib/index.js",
|
||||
"scripts": {
|
||||
|
|
@ -282,6 +282,8 @@
|
|||
"menu/",
|
||||
"cli.js",
|
||||
"index.js",
|
||||
"index.d.ts",
|
||||
"package-lock.json",
|
||||
"bloggify.js",
|
||||
"bloggify.json",
|
||||
"bloggify/"
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue