From b986b6fe00d0af99b76352e0b937fe8d24350cd0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Chr=C3=A1stek?= Date: Thu, 18 May 2023 15:17:46 +0200 Subject: [PATCH] chore: Improve repo health (#46) --- CONTRIBUTING.md | 25 +++++++++++++++++++++++++ package.json | 4 ++++ 2 files changed, 29 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..fc3e911d --- /dev/null +++ b/CONTRIBUTING.md @@ -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) \ No newline at end of file diff --git a/package.json b/package.json index f547c0c0..9c65b224 100644 --- a/package.json +++ b/package.json @@ -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" },