-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- numbers-to-words was already taken
- Loading branch information
Showing
5 changed files
with
41 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Contribution Guidelines | ||
Well, thanks for taking a time to contribute! This is really awesome! :tada: | ||
|
||
|
||
## How to Contribute? | ||
There are many ways to contribute with this project: from bug reporting to performance/code enhancements, asking for new features, improving documentation... | ||
|
||
To do so, first take a look on the [opened issues](https://github.com/jlozovei/full-numbers/issues). If you don't find any that fits your request/problem you can [open a new issue](https://github.com/jlozovei/full-numbers/issues/new) and provide a nice description of what you are asking; technical references (links, reports...) and code samples are always welcome, and they help us to find the better solution for the problems. | ||
|
||
|
||
## Coding Conventions | ||
Personally I'm not stricted to any `JavaScript Guideline`, but I like to keep nice patterns and use community approved conventions. | ||
|
||
So, if you use the project's linting rules and conventions your request will be halfway approved! | ||
|
||
Also, if possible, create test cases for your modifications - it's very important to keep the project's quality and assurance of good code! | ||
|
||
|
||
## Pull Requests | ||
To create a nice PR, follow the [template](https://github.com/jlozovei/full-numbers/blob/master/.github/PULL_REQUEST_TEMPLATE.md). The goal will always be to maintain/improve the project's quality and fix the existing problems; and to do so, we must keep a pattern. | ||
|
||
|
||
## Is it your first contribution? | ||
Take a look at the [beginner issues](https://github.com/jlozovei/full-numbers/labels/beginner) and [help wanted issues](https://github.com/jlozovei/full-numbers/labels/help%20wanted), they are a nice way to start. | ||
|
||
Either in the project or in the open source community, your contribution will always be welcome. We (the community) will help you to create a nice and worthy contribution! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
{ | ||
"name": "numbers-to-words", | ||
"name": "full-numbers", | ||
"version": "0.0.0", | ||
"description": "A nice JS package to convert numbers to words.", | ||
"main": "index.js", | ||
|
@@ -13,25 +13,24 @@ | |
}, | ||
"repository": { | ||
"type": "git", | ||
"url": "git+https://github.com/jlozovei/numbers-to-words.git" | ||
"url": "git+https://github.com/jlozovei/full-numbers.git" | ||
}, | ||
"author": "Julio Lozovei <[email protected]> (https://jlozovei.dev)", | ||
"license": "MIT", | ||
"bugs": { | ||
"url": "https://github.com/jlozovei/numbers-to-words/issues" | ||
"url": "https://github.com/jlozovei/full-numbers/issues" | ||
}, | ||
"homepage": "https://github.com/jlozovei/numbers-to-words#readme", | ||
"homepage": "https://github.com/jlozovei/full-numbers#readme", | ||
"files": [ | ||
"dist" | ||
], | ||
"keywords": [ | ||
"converter", | ||
"currency", | ||
"number", | ||
"string", | ||
"full numbers", | ||
"numbers to words", | ||
"currency to words" | ||
"numbers in full", | ||
"numbers to words" | ||
], | ||
"devDependencies": { | ||
"eslint": "^6.8.0", | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters