11[ ![ GitHub Workflow Status (branch)] ( https://img.shields.io/github/actions/workflow/status/go-xlan/gitgo/release.yml?branch=main&label=BUILD )] ( https://github.com/go-xlan/gitgo/actions/workflows/release.yml?query=branch%3Amain )
22[ ![ GoDoc] ( https://pkg.go.dev/badge/github.com/go-xlan/gitgo )] ( https://pkg.go.dev/github.com/go-xlan/gitgo )
33[ ![ Coverage Status] ( https://img.shields.io/coveralls/github/go-xlan/gitgo/main.svg )] ( https://coveralls.io/github/go-xlan/gitgo?branch=main )
4- [ ![ Supported Go Versions] ( https://img.shields.io/badge/Go-1.25+ -lightgrey.svg )] ( https://github.com/go-xlan/gitgo )
4+ [ ![ Supported Go Versions] ( https://img.shields.io/badge/Go-1.25%2B -lightgrey.svg )] ( https://go.dev/ )
55[ ![ GitHub Release] ( https://img.shields.io/github/release/go-xlan/gitgo.svg )] ( https://github.com/go-xlan/gitgo/releases )
66[ ![ Go Report Card] ( https://goreportcard.com/badge/github.com/go-xlan/gitgo )] ( https://goreportcard.com/report/github.com/go-xlan/gitgo )
77
@@ -12,9 +12,11 @@ Streamlined Git command execution engine with fluent chaining interface and comp
1212---
1313
1414<!-- TEMPLATE (EN) BEGIN: LANGUAGE NAVIGATION -->
15+
1516## CHINESE README
1617
1718[ 中文说明] ( README.zh.md )
19+
1820<!-- TEMPLATE (EN) END: LANGUAGE NAVIGATION -->
1921
2022## Main Features
@@ -199,6 +201,7 @@ func main() {
199201- ` GetCommitHash(ref) (string, error) ` - Get commit hash with reference
200202- ` GetRemoteURL(remote) (string, error) ` - Get remote repo URL
201203- ` GetIgnoredFiles() ([]string, error) ` - Get files ignored in gitignore
204+ - ` ConfigGet(key) (string, error) ` - Get Git configuration value
202205
203206### Tag Operations
204207
@@ -210,67 +213,67 @@ func main() {
210213- ` MustDone() *Gcm ` - Panic when issues happen
211214
212215<!-- TEMPLATE (EN) BEGIN: STANDARD PROJECT FOOTER -->
213- <!-- VERSION 2025-09-06 04:53:24.895249 +0000 UTC -->
216+ <!-- VERSION 2025-11-25 03:52:28.131064 +0000 UTC -->
214217
215218## 📄 License
216219
217- MIT License. See [ LICENSE] ( LICENSE ) .
220+ MIT License - see [ LICENSE] ( LICENSE ) .
218221
219222---
220223
221- ## 🤝 Contributing
224+ ## 💬 Contact & Feedback
222225
223226Contributions are welcome! Report bugs, suggest features, and contribute code:
224227
225- - 🐛 ** Found a bug ?** Open an issue on GitHub with reproduction steps
226- - 💡 ** Have a feature idea ?** Create an issue to discuss the concept
227- - 📖 ** Documentation confusing?** Report it and we can enhance
228- - 🚀 ** Need new features?** Share the use cases to help us understand needs
228+ - 🐛 ** Mistake reports ?** Open an issue on GitHub with reproduction steps
229+ - 💡 ** Fresh ideas ?** Create an issue to discuss
230+ - 📖 ** Documentation confusing?** Report it so we can improve
231+ - 🚀 ** Need new features?** Share the use cases to help us understand requirements
229232- ⚡ ** Performance issue?** Help us optimize through reporting slow operations
230233- 🔧 ** Configuration problem?** Ask questions about complex setups
231234- 📢 ** Follow project progress?** Watch the repo to get new releases and features
232- - 🌟 ** Success stories?** Share how this package helped the workflow
233- - 💬 ** Feedback?** We welcome input and comments
235+ - 🌟 ** Success stories?** Share how this package improved the workflow
236+ - 💬 ** Feedback?** We welcome suggestions and comments
234237
235238---
236239
237240## 🔧 Development
238241
239- When contributing new code, follow this process:
242+ New code contributions , follow this process:
240243
241- 1 . ** Fork** : Fork the repo on GitHub (using the webpage UI)
242- 2 . ** Clone** : Clone the forked project (` git clone https://github.com/yourname/repo-name.git ` )
244+ 1 . ** Fork** : Fork the repo on GitHub (using the webpage UI).
245+ 2 . ** Clone** : Clone the forked project (` git clone https://github.com/yourname/repo-name.git ` ).
2432463 . ** Navigate** : Navigate to the cloned project (` cd repo-name ` )
244- 4 . ** Branch** : Create a feature branch (` git checkout -b feature/xxx ` )
247+ 4 . ** Branch** : Create a feature branch (` git checkout -b feature/xxx ` ).
2452485 . ** Code** : Implement the changes with comprehensive tests
246- 6 . ** Testing** : (Golang project) Make sure tests pass (` go test ./... ` ) and follow Go code conventions
247- 7 . ** Documentation** : Update documentation to support changes and write commit messages with substance
249+ 6 . ** Testing** : (Golang project) Ensure tests pass (` go test ./... ` ) and follow Go code style conventions
250+ 7 . ** Documentation** : Update documentation to support client-facing changes
2482518 . ** Stage** : Stage changes (` git add . ` )
249- 9 . ** Commit** : Commit changes (` git commit -m "Add feature xxx" ` ) with backward compatible code
250- 10 . ** Push** : Push to the branch (` git push origin feature/xxx ` )
251- 11 . ** PR** : Open a PR on GitHub (on the GitHub webpage) with detailed description
252+ 9 . ** Commit** : Commit changes (` git commit -m "Add feature xxx" ` ) ensuring backward compatible code
253+ 10 . ** Push** : Push to the branch (` git push origin feature/xxx ` ).
254+ 11 . ** PR** : Open a merge request on GitHub (on the GitHub webpage) with detailed description.
252255
253- Make sure tests pass and include documentation updates as needed .
256+ Please ensure tests pass and include relevant documentation updates.
254257
255258---
256259
257260## 🌟 Support
258261
259- Welcome to contribute to this project through submitting PRs and reporting issues.
262+ Welcome to contribute to this project via submitting merge requests and reporting issues.
260263
261264** Project Support:**
262265
263- - ⭐ ** Give GitHub stars** when this project helps you
266+ - ⭐ ** Give GitHub stars** if this project helps you
264267- 🤝 ** Share with teammates** and (golang) programming friends
265268- 📝 ** Write tech blogs** about development tools and workflows - we provide content writing support
266269- 🌟 ** Join the ecosystem** - committed to supporting open source and the (golang) development scene
267270
268- ** Have Fun Coding with this package!** 🎉
271+ ** Have Fun Coding with this package!** 🎉🎉🎉
269272
270273<!-- TEMPLATE (EN) END: STANDARD PROJECT FOOTER -->
271274
272275---
273276
274277## GitHub Stars
275278
276- [ ![ Stargazers] ( https://starchart.cc/go-xlan/gitgo.svg?variant=adaptive )] ( https://starchart.cc/go-xlan/gitgo )
279+ [ ![ Stargazers] ( https://starchart.cc/go-xlan/gitgo.svg?variant=adaptive )] ( https://starchart.cc/go-xlan/gitgo )
0 commit comments