Skip to content

Commit

Permalink
chore: Improve repo health (#46)
Browse files Browse the repository at this point in the history
  • Loading branch information
Martin005 authored May 18, 2023
1 parent 0657a36 commit b986b6f
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# How to Contribute

We're excited you're interested in contributing to the Tolgee CLI! We'd love your help, and there are plenty of ways to
contribute:

* Give the repo a star
* Join our [Slack community](https://tolg.ee/slack)
and leave us feedback or help with answering questions from the community
* Fix or [report](https://github.com/tolgee/tolgee-cli/issues/new) a bug
* Fix or improve [documentation](https://github.com/tolgee/documentation)
* For newcomers, pick up a ["good first issue"](https://github.com/tolgee/tolgee-cli/labels/good%20first%20issue),
then send a pull request our way (see the [resources](#resources) section below for helpful links to get started)

## Running and debugging the project

- Everything you should know is described in the [HACKING.md file](HACKING.md)

# Resources

* [How to Contribute to Open Source](https://opensource.guide/how-to-contribute)
* [Using the Fork-and-Branch Git Workflow](https://blog.scottlowe.org/2015/01/27/using-fork-branch-git-workflow)
* [Understanding the GitHub flow](https://guides.github.com/introduction/flow/)
* [Keep a Changelog](https://keepachangelog.com)
* [Code Review Developer Guide](https://google.github.io/eng-practices/review)
* [Signing Commits](https://docs.github.com/en/github/authenticating-to-github/signing-commits)
4 changes: 4 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
"version": "0.1.0",
"type": "commonjs",
"description": "A tool to interact with the Tolgee Platform through CLI",
"repository": {
"type": "git",
"url": "https://github.com/tolgee/tolgee-cli.git"
},
"bin": {
"tolgee": "./dist/index.js"
},
Expand Down

0 comments on commit b986b6f

Please sign in to comment.