Skip to content
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
20 changes: 10 additions & 10 deletions contributor_docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,28 +76,28 @@ This process is also covered [in a video by The Coding Train.](https://youtu.be/

3. [Clone](https://help.github.com/articles/cloning-a-repository/) your new fork of the repository from GitHub onto your local computer.

```
```shell
$ git clone https://github.com/YOUR_USERNAME/p5.js.git
```

4. Navigate into the project folder and install all its necessary dependencies with npm.

```
```shell
$ cd p5.js
$ npm ci
```

5. [Grunt](https://gruntjs.com/) should now be installed, and you can use it to build the library from the source code.

```
```shell
$ npm run grunt
```

If you're continuously changing files in the library, you may want to run `npm run dev` to automatically rebuild the library for you whenever any of its source files change without you having to first type the command manually.

6. Make some changes locally to the codebase and [commit](https://help.github.com/articles/github-glossary/#commit) them with Git.

```
```shell
$ git add -u
$ git commit -m "YOUR COMMIT MESSAGE"
```
Expand All @@ -106,7 +106,7 @@ This process is also covered [in a video by The Coding Train.](https://youtu.be/

8. [Push](https://help.github.com/articles/github-glossary/#push) your new changes to your fork on GitHub.

```
```shell
$ git push
```

Expand All @@ -124,13 +124,13 @@ p5.js requires clean and stylistically consistent code syntax, which it enforces

To detect errors, run the following command in your terminal (do not type the `$` prompt):

```
```shell
$ npm run lint
```

Some syntax errors can be automatically fixed:

```
```shell
$ npm run lint:fix
```

Expand Down Expand Up @@ -159,7 +159,7 @@ Unit tests are small pieces of code which are created as complements to the prim

In order to run unit tests, you'll need to make sure you have installed the project's dependencies.

```
```shell
$ npm ci
```

Expand All @@ -170,13 +170,13 @@ This will install *all* the dependencies for p5.js; briefly, the most important

Once the dependencies are installed, use Grunt to run the unit tests.

```
```shell
$ grunt
```

Sometimes it is useful to run the tests in the browser instead of on the command line. To do this, first start the [connect](https://github.com/gruntjs/grunt-contrib-connect) server:

```
```shell
$ npm run dev
```

Expand Down
20 changes: 10 additions & 10 deletions contributor_docs/hi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,28 +60,28 @@ p5.js में योगदान देने में आपकी रुच
2. [फोर्क](https://help.github.com/articles/fork-a-repo) [p5.js रिपॉजिटरी](https://github.com/processing/p5.js) अपने खुद के गिटहब खाते में।
3. [क्लोन](https://help.github.com/articles/cloning-a-repository/) आपके स्थानीय कंप्यूटर पर गिटहब से रिपॉजिटरी का नया फोर्क।

```
```shell
$ git clone https://github.com/YOUR_USERNAME/p5.js.git
```

4. प्रोजेक्ट फ़ोल्डर में नेविगेट करें और npm के साथ अपनी सभी आवश्यक निर्भरताएं स्थापित करें।

```
```shell
$ cd p5.js
$ npm ci
```

5. [ग्रंट](https://gruntjs.com/) अब स्थापित किया जाना चाहिए, और आप इसका उपयोग स्रोत कोड से लाइब्रेरी बनाने के लिए कर सकते हैं।

```
```shell
$ npm run grunt
```

यदि आप लाइब्रेरी में लगातार फाइलों को बदल रहे हैं, तो आप अपने लिए लाइब्रेरी को स्वचालित रूप से पुनर्निर्माण करने के लिए `npm run dev` को चलाना चाहते हैं, जब भी इसका कोई भी सोर्स आपके बिना पहली बार मैन्युअल रूप से टाइप किए बिना बदल जाता है।

6. स्थानीय रूप से कोडबेस और [कमिट](https://help.github.com/articles/github-glossary/#commit) में कुछ बदलाव करें।

```
```shell
$ git add -u
$ git commit -m "YOUR COMMIT MESSAGE"
```
Expand All @@ -90,7 +90,7 @@ p5.js में योगदान देने में आपकी रुच

8. [पुश](https://help.github.com/articles/github-glossary/#push) गिटहब पर आपके फोर्क में आपके नए परिवर्तन।

```
```shell
$ git push
```

Expand All @@ -108,13 +108,13 @@ p5.js को स्वच्छ और शैलीगत सुसंगत क

त्रुटियों का पता लगाने के लिए, अपने टर्मिनल में निम्न कमांड चलाएँ (`$` प्रांप्ट टाइप न करें):

```
```shell
$ npm run lint
```

कुछ सिंटैक्स त्रुटियां स्वचालित रूप से ठीक की जा सकती हैं:

```
```shell
$ npm run lint:fix
```

Expand All @@ -136,7 +136,7 @@ $ npm run lint:fix

इकाई परीक्षण चलाने के लिए, आपको पहले परियोजना की निर्भरताएँ स्थापित करनी होंगी।

```
```shell
$ npm ci
```

Expand All @@ -147,13 +147,13 @@ $ npm ci

एक बार निर्भरताएं स्थापित हो जाने के बाद, यूनिट परीक्षणों को चलाने के लिए ग्रंट का उपयोग करें।

```
```shell
$ grunt
```

कभी-कभी कमांड लाइन पर के बजाय ब्राउज़र में परीक्षण चलाना उपयोगी होता है। ऐसा करने के लिए, पहले [कनेक्ट](https://github.com/gruntjs/grunt-contrib-connect) सर्वर शुरू करें:

```
```shell
$ npm run dev
```

Expand Down
12 changes: 6 additions & 6 deletions contributor_docs/hi/preparing_a_pull_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,21 @@
### परिवर्तनों के बारे में जानें
सुनिश्चित करें कि आप अपस्ट्रीम p5.js रिपॉजिटरी को ट्रैक कर रहे हैं।

git remote show upstream
$ git remote show upstream

यदि आपको कोई त्रुटि दिखाई देती है, तो आपको "upstream" रिमोट रिपॉजिटरी के रूप में मुख्य p5.js रेपो को ट्रैक करना शुरू करना होगा। आपको केवल एक बार ऐसा करने की आवश्यकता होगी! लेकिन, अगर आप इसे दूसरी बार चलाते हैं तो कोई नुकसान नहीं होता है।

git remote add upstream https://github.com/processing/p5.js
$ git remote add upstream https://github.com/processing/p5.js

फिर नवीनतम परिवर्तनों के बारे में पूछें।

git fetch upstream
$ git fetch upstream

### शायद ज़रुरत पड़े- एक नई शाखा में अपने परिवर्तनों की एक प्रति बनाएँ
git branch your-branch-name-backup
$ git branch your-branch-name-backup

### मुख्य शाखा से परिवर्तन लागू करता है, *बाद में* अपने परिवर्तन जोड़ता है
git rebase upstream/main
$ git rebase upstream/main

### विवादों का समाधान
आपकी शाखा में कुछ उलझनें हो सकती हैं!
Expand All @@ -39,7 +39,7 @@
यदि आपके पास अन्य फ़ाइलों में विरोध है और आप सुनिश्चित नहीं हैं कि उन्हें कैसे हल किया जाए ... मदद के लिए पूछें!

### और अंत में, महान गौरव के लिए
git push origin
$ git push origin

यदि आप तकनीकी विवरणों के बारे में गहन जानकारी प्राप्त कर रहे हैं, तो रेबेसिंग पर एक अच्छा संदर्भ है। https://www.atlassian.com/git/tutorials/merging-vs-rebasing

Expand Down
10 changes: 5 additions & 5 deletions contributor_docs/hi/unit_testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@

### सभी यूनिट टेस्ट को चलाना
रेपो रूट में, अपने टर्मिनल में निम्न कमांड का उपयोग करें
```
npm test
```shell
$ npm test
```

### परीक्षण कवरेज
Expand All @@ -25,7 +25,7 @@ npm test
### एक उदाहरण

केवल "p5.ColorConversion" परीक्षणों का सूट चलाने के लिए, आप पढ़ने के लिए ```test/unit/color/color_conversion.js``` की पहली पंक्ति को बदल देंगे-
```
```js
suite.only('color/p5.ColorConversion', function() {
```

Expand Down Expand Up @@ -80,7 +80,7 @@ Node.js परीक्षणों के लिए सेटअप सभी `

हम ```p5.prototype.isKeyPressed``` के लिए एक परीक्षण सूट बना सकते हैं और इसके लिए परीक्षण बनाना शुरू कर सकते हैं। हम अपने यूनिट परीक्षणों की संरचना के लिए Mocha का उपयोग करेंगे।

```
```js
suite('p5.prototype.keyIsPressed', function() {
test('keyIsPressed is a boolean', function() {
//परीक्षण यहाँ लिखें
Expand All @@ -98,7 +98,7 @@ suite('p5.prototype.keyIsPressed', function() {

हमने परीक्षणों की संरचना की है, लेकिन हमने अभी तक परीक्षण नहीं लिखे हैं। हम इसके लिए ची के दावे का उपयोग करेंगे। निम्नलिखित को धयान मे रखते हुए-

```
```js
test('keyIsPressed is a boolean', function() {
assert.isBoolean(myp5.keyIsPressed); //दावा करता है कि मूल्य एक बूलियन है।
});
Expand Down
16 changes: 8 additions & 8 deletions contributor_docs/inline_documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You must specify one of these for the element to appear in the docs, with the na
* When possible, link to other files when mentioning other function or variable names. For example, you can see the preload method linked in the description for [loadImage](https://github.com/processing/p5.js/blob/main/src/image/loading_displaying.js#L21).
* Here is [yuidoc's reference](http://yui.github.io/yuidoc/syntax/index.html#basic-requirements) for more syntax information.

```
```js
/**
* The x component of the vector
* @property x
Expand All @@ -25,7 +25,7 @@ You must specify one of these for the element to appear in the docs, with the na
this.x = x || 0;
```

```
```js

/**
* Draw an arc
Expand All @@ -45,7 +45,7 @@ You must specify one of these for the element to appear in the docs, with the na
*/
```

```
```js
/**
*
* Calculates the magnitude (length) of the vector and returns the result
Expand Down Expand Up @@ -98,7 +98,7 @@ If the method returns the parent object, you can skip the `@return` and add this

If a method has multiple possible parameter options, you can specify each individually. For example, see the examples for [background](http://p5js.org/reference/#p5/background) under "syntax". To do this, choose one version to list as the first signature using the guidelines above. At the end of the documentation block, you can add additional signatures, each in its own block, following the example below.

```
```js
/**
* @method background
* @param {String} colorstring color string, possible formats include: integer
Expand All @@ -123,7 +123,7 @@ Notes:

Use `@final` if a property or variable is a constant:

```
```js
/**
* PI is a mathematical constant with the value 3.14159265358979323846.
* @property PI
Expand All @@ -135,7 +135,7 @@ Use `@final` if a property or variable is a constant:

Use `@private` if a property or variable is a private variable (default is `@public` so no need to specify).

```
```js
/**
* _start calls preload() setup() and draw()
*
Expand All @@ -149,7 +149,7 @@ Use `@private` if a property or variable is a private variable (default is `@pub

The top of each *file* should contain a `@module` tag. Modules should correspond to JavaScript files (or require.js modules). They can work as groups in the lists of items. See [here](https://p5js.org/reference/#collection-list-nav) (the modules are COLOR, IMAGE, IO, PVECTOR, etc.).

```
```js
/**
* @module image
*/
Expand All @@ -163,7 +163,7 @@ define(function (require) {

Constructors are defined with `@class`. Each constructor should have the tag `@class` followed by the name of the class, as well as the tag `@constructor`, and any `@param` tags required.

```
```js
/**
* The p5 constructor function.
* @class p5
Expand Down
20 changes: 10 additions & 10 deletions contributor_docs/ko/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,28 +75,28 @@ p5.js 프로젝트의 핵심적인 저장소들은 아래와 같습니다:

3. 포크 된 깃허브 저장소를 로컬 컴퓨터에 [클론](https://help.github.com/articles/cloning-a-repository/) 하십시오.

```
```shell
$ git clone https://github.com/YOUR_USERNAME/p5.js.git
```

4. 프로젝트 폴더로 들어가 npm에 필요한 모든 디펜던시를 설치하십시오.

```
```shell
$ cd p5.js
$ npm ci
```

5. 이제 [Grunt](https://gruntjs.com/)가 설치되었을텐데, 소스 코드로부터 라이브러리를 빌드하기 위해 이를 이용할 수 있습니다.

```
```shell
$ npm run grunt
```

만약 라이브러리의 파일을 계속해서 변경해야 한다면, 사전에 수동으로 일일이 명령어를 입력하지 않아도 소스 파일 변경 사항을 자동적으로 다시 빌드해줄 수 있도록 `npm run dev`를 실행 하는 게 나을 것입니다.

6. 로컬에서 코드 베이스를 변경하고, 깃(Git)으로 [커밋](https://help.github.com/articles/github-glossary/#commit) 하십시오.

```
```shell
$ git add -u
$ git commit -m "YOUR COMMIT MESSAGE"
```
Expand All @@ -105,7 +105,7 @@ p5.js 프로젝트의 핵심적인 저장소들은 아래와 같습니다:

8. 변경 사항을 여러분의 깃허브 포크에 [푸시](https://help.github.com/articles/github-glossary/#push) 하십시오.

```
```shell
$ git push
```

Expand All @@ -123,13 +123,13 @@ p5.js는 깔끔하고 일관성 있는 스타일의 코드 문법을 요구하

에러를 포착하기 위해서는 터미널에서 다음 명령어를 실행하세요(`$` 프롬프트는 입력하지 마십시오):

```
```shell
$ npm run lint
```

어떤 문법 오류는 자동적으로 고쳐질 수도 있습니다:

```
```shell
$ npm run lint:fix
```

Expand Down Expand Up @@ -158,7 +158,7 @@ $ npm run lint:fix

유닛 테스트를 돌리기 위해서는 프로젝트의 디펜던시들을 반드시 설치해야 합니다.

```
```shell
$ npm ci
```

Expand All @@ -169,13 +169,13 @@ $ npm ci

디펜던시들이 설치되면, Grunt를 이용해 유닛 테스트를 돌리십시오.

```
```shell
$ grunt
```

때론 커맨드 라인 대신 브라우저에서 테스트를 돌리는 것도 유용합니다. 이를 위해선, 먼저 서버 [연결](https://github.com/gruntjs/grunt-contrib-connect)을 시작하십시오:

```
```shell
$ npm run dev
```

Expand Down
Loading