Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: remove deprecated contact number and update links #174

Merged
merged 1 commit into from
Oct 29, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 13 additions & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Contributing to Gurmukhi Utils
# Contributing to Presenter

Thank you for your interest in participating!

There are many ways for people to contribute, beyond writing code or programming, by: logging bugs, reporting issues, and creating suggestions. To do so, please [create a ticket](https://github.com/ShabadOS/gurmukhi-utils/issues/new) in our issue tracker. (See our readme for other ways to [Contribute](README.md#Contributing) or give [Feedback](README.md#Feedback).
There are many ways to contribute, beyond writing code or programming, by: logging bugs, reporting issues, and creating suggestions. To do so, please [create a ticket](https://github.com/ShabadOS/gurmukhi-utils/issues/new) in our issue tracker. (See other ways to [Contribute](README.md#Contributing) or give [Feedback](README.md#Feedback).

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

Expand All @@ -16,7 +16,7 @@ This document is for developers or programmers contributing to the source code o
- [Workflow](#workflow)
- [Coding Guidelines](#coding-guidelines)
- [Scope](#scope)
- [Thank you!](#thank-you)
- [Thank you](#thank-you)

## Getting Started

Expand All @@ -34,7 +34,7 @@ You’ll need the following:
Get the source code of `gurmukhi-utils` repo:

```
gh repo fork shabados/gurmukhi-utils --clone=true --remote=true
gh repo fork shabados/gurmukhi-utils --clone=true
```

**PROTIP**: Use the [`gh` cli tool from GitHub](https://cli.github.com/) to fork the repo to your GitHub account (if not already), clone it to your local machine, and set the appropriate remotes for origin and upstream with the above command.
Expand Down Expand Up @@ -67,30 +67,26 @@ _Note to contributors with push access to main:_ Any commits or merge commits co

## Workflow

The workflow of development (or Git Flow) is to [choose/create an issue](https://github.com/ShabadOS/gurmukhi-utils/issues) to work on, [create a feature branch](https://github.com/ShabadOS/.github/wiki/How-to-Contribute#branches), and [submit a pull request](https://github.com/ShabadOS/.github/wiki/How-to-Contribute#pull-requests).
The workflow of development (or Git Flow) is to [choose/create an issue](https://github.com/ShabadOS/presenter/issues) to work on, [create a feature branch](https://github.com/ShabadOS/.github/wiki/How-to-Contribute#branches), and [submit a pull request](https://github.com/ShabadOS/.github/wiki/How-to-Contribute#pull-requests).

**PROTIP**: Read more about our workflow (issue tracking, branching, and pull requests) in the [How To Contribute wiki article](https://github.com/ShabadOS/.github/wiki/How-to-Contribute).

**Recommended Flow:**

- Write or update existing tests with expected results
- Implement functions/changes
- Add JSDoc function documentation and examples.
- Run tests with `npm test` and ensure they all pass.

### Coding Guidelines

Please see the [wiki](https://github.com/ShabadOS/.github/wiki/How-to-Contribute#coding-guidelines) for Coding Guidelines ([Names](https://github.com/ShabadOS/.github/wiki/How-to-Contribute#41-names), [Comments](https://github.com/ShabadOS/.github/wiki/How-to-Contribute#42-comments), [Style](https://github.com/ShabadOS/.github/wiki/How-to-Contribute#43-style), [Linting](https://github.com/ShabadOS/.github/wiki/How-to-Contribute#44-linting), and [Commit Messages](https://github.com/ShabadOS/.github/wiki/How-to-Contribute#45-commit-messages)).

### Scope

The scope should be the name of the function affected (e.g. `toEnglish`, `isGurmukhi`, `stripVishraams`).
To be used in [commit messages](https://github.com/ShabadOS/.github/wiki/How-to-Contribute#45-commit-messages).

A few exceptions to the above "use function name" rule:
Usage:

- `style`, `test`, and `refactor` changes to multiple functions do not require a scope name (e.g. `style: add missing semicolons`).
- `docs` changes do not require a scope name (e.g. `docs: fix typo in readme.hbs`).
```shell
<type>(<scope>): <subject>
```

The scope should be the name of the function affected (e.g. `toEnglish`, `isGurmukhi`, `stripVishraams`).

## Thank you!
## 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.
Loading