Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

docs: improve the contributing guidelines#1271

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
raklaptudirm merged 1 commit intomasterfromimprove_contributing
Dec 18, 2022
Merged
Changes fromall 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
60 changes: 40 additions & 20 deletionsCONTRIBUTING.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,9 +2,9 @@

## Before contributing

Welcome to [TheAlgorithms/Javascript](https://github.com/TheAlgorithms/Javascript)! Before sending your pull requests,
make sure that you **read the whole guidelines**. If you have anydoubt on the contributing guide, please feel free to
[stateit clearly in an issue](https://github.com/TheAlgorithms/Javascript/issues/new).
Welcome to [TheAlgorithms/JavaScript](https://github.com/TheAlgorithms/JavaScript)! Before sending your pull requests,
make sure that you **read the whole guidelines**. If you have anydoubts about the contributing guide, please feel free to
[statethem clearly in an issue](https://github.com/TheAlgorithms/JavaScript/issues/new) or by joining our [Discord community](https://the-algorithms.com/discord).

## Contributing

Expand All@@ -15,11 +15,11 @@ referenced and used by learners from around the globe. Being one of our contribu

- You did your work - plagiarism is not allowed.
- Any plagiarized work will not be merged.
- Your work will be distributed under [GNULicense](LICENSE) once your pull request is merged.
- Your work will be distributed underthe[GNUGPLv3.0](https://github.com/TheAlgorithms/JavaScript/blob/master/LICENSE) once your pull request is merged.
- Your submitted work must fulfill our styles and standards.

**Newimplementation**is welcome! For example, new solutions to a problem, different representations of a graph data
structure or algorithm designs with different complexity.
**Newimplementations**are welcome! For example, new solutions to a problem, different representations of a graph data
structure, or algorithm designs with different complexity.

**Improving comments** and **writing proper tests** are also highly welcome.

Expand DownExpand Up@@ -52,18 +52,38 @@ Algorithms should:
Algorithms in this repo should not be how-to examples for existing JavaScript packages. Instead, they should perform
internal calculations or manipulations to convert input values into different output values. Those calculations or
manipulations can use data types, classes, or functions of existing JavaScript packages but each algorithm in this repo
should add unique value.
should add a unique value.

#### Commit guidelines

- Follow [**Conventional Commits**](https://www.conventionalcommits.org/en/v1.0.0/) guidelines at all times.
- Use one of the following prefixes (there might be other miscellaneous prefixes, though).
- fix: A bug fix in an algorithm, workflow, configuration/settings, etc..
- feat: A new feature, such as new algorithms, new workflows, etc..
- docs: Documentation changes or fixes, like improving the contributing guidelines, fixing a typo, etc..
- test: Correct existing tests or add new ones.
- chore: Miscellaneous changes that do not match any of the above.

Examples of best commit messages.

```txt
fix: fixed error in XYZ algorithm
feat: re-work the CI workflow
docs: improve the contributing guidelines
test: add self-tests for XYZ algorithm
chore: update readme badges
```

#### File Naming Convention

-filenames should use the UpperCamelCase (PascalCase) style.
-Filenames should use the UpperCamelCase (PascalCase) style.
- There should be no spaces in filenames.
- **Example:** `UserProfile.js` is allowed but `userprofile.js`,`Userprofile.js`,`user-Profile.js`,`userProfile.js` are
not.

#### Module System

We use the [ES Module](https://hacks.mozilla.org/2018/03/es-modules-a-cartoon-deep-dive/) system, whichbring an
We use the [ES Module](https://hacks.mozilla.org/2018/03/es-modules-a-cartoon-deep-dive/) system, whichbrings an
official, standardized module system to JavaScript.

It roughly means you will need to use `export` and `import` statements instead of `module.exports` and `require()`.
Expand All@@ -83,34 +103,34 @@ and inspect the outcome. Example: [RatInAMaze.test.js](Backtracking/tests/RatInA

Please refrain from using `console` in your implementation AND test code.

First you should install all dependencies using:
First, you should install all dependencies using:

```shell
```bash
npm install
```

You can (and should!) run all tests locally before committing your changes:

```shell
```bash
npm test
```

If you want save some time and just run a specific test:
If you wanttosave some time and just run a specific test:

```shell
```bash
# This will run any test file where the filename contains "koch" (no need to specify folder path)
npm test -- koch
```

You can also start Jest in "watch" mode:

```shell
```bash
npm test -- --watchAll
```

We also prepared a helper script that runs tests only for changed files:

```shell
```bash
npm run test-changed
```

Expand All@@ -121,9 +141,9 @@ This will run all tests and watch source and test files for changes. When a chan
To maximize the readability and correctness of our code, we require that new submissions follow the
[JavaScript Standard Style](https://standardjs.com/).

Before committing, please run
Before committing, please run:

```shell
```bash
npm run style
```

Expand All@@ -134,7 +154,7 @@ A few (but not all) of the things to keep in mind:

- Use camelCase with the leading character as lowercase for identifier names (variables and functions).
- Names start with a letter.
- Follow code indentation: Always use 2 spaces forindentation ofcode blocks.
- Follow code indentation: Always use 2 spaces for code-block indentation.

```js
function sumOfArray(arrayOfNumbers) {
Expand All@@ -158,4 +178,4 @@ function sumOfArray(arrayOfNumbers) {
- **Be consistent in the use of these guidelines when submitting.**
- Happy coding!

Writer [@itsvinayak](https://github.com/itsvinayak), May 2020.
Writer [@itsvinayak](https://github.com/itsvinayak) and contributors, May 2020.
[8]ページ先頭
©2009-2025 Movatter.jp