Skip to content

Latest commit

 

History

History
48 lines (28 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

48 lines (28 loc) · 1.52 KB
Raw

Contributing Code

Thank you for your interest in participating!

There are many ways to contribute, beyond writing code or programming, by: asking questions, reporting bugs, and suggesting features. To do so, please log a new issue.

This document is for developers or programmers contributing to the source code.

Get Started

You will need to create a Google Cloud Project with the Translate API enabled to try out punjabi to english translating.

Translations will be enabled if the GOOGLE_APPLICATION_CREDENTIALS environment variable is set to a path that contains the credentials for a Google Cloud Project's service account, which you must create. Learn more about setting up the Google Cloud Project.

Build

Run npm i in the root directory.

Start

npm start

Run

Usage:

npm run <command>

Some featured commands:

test
lint

Run npm run or open the package.json file(s) for a full list of commands.

Contributing

Please see our organization docs on contributing. These cover important aspects including workflow (how to submit a PR), coding guidelines (how to write a commit message), and project management (latest/next release information).

Thank you

Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to participate in this project!