You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
4. Navigate into the project folder and install all its necessary dependencies with npm.
84
84
85
-
```
85
+
```shell
86
86
$ cd p5.js
87
87
$ npm ci
88
88
```
89
89
90
90
5.[Grunt](https://gruntjs.com/) should now be installed, and you can use it to build the library from the source code.
91
91
92
-
```
92
+
```shell
93
93
$ npm run grunt
94
94
```
95
95
96
96
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.
97
97
98
98
6. Make some changes locally to the codebase and [commit](https://help.github.com/articles/github-glossary/#commit) them with Git.
99
99
100
-
```
100
+
```shell
101
101
$ git add -u
102
102
$ git commit -m "YOUR COMMIT MESSAGE"
103
103
```
@@ -106,7 +106,7 @@ This process is also covered [in a video by The Coding Train.](https://youtu.be/
106
106
107
107
8.[Push](https://help.github.com/articles/github-glossary/#push) your new changes to your fork on GitHub.
108
108
109
-
```
109
+
```shell
110
110
$ git push
111
111
```
112
112
@@ -124,13 +124,13 @@ p5.js requires clean and stylistically consistent code syntax, which it enforces
124
124
125
125
To detect errors, run the following command in your terminal (do not type the `$` prompt):
126
126
127
-
```
127
+
```shell
128
128
$ npm run lint
129
129
```
130
130
131
131
Some syntax errors can be automatically fixed:
132
132
133
-
```
133
+
```shell
134
134
$ npm run lint:fix
135
135
```
136
136
@@ -159,7 +159,7 @@ Unit tests are small pieces of code which are created as complements to the prim
159
159
160
160
In order to run unit tests, you'll need to make sure you have installed the project's dependencies.
161
161
162
-
```
162
+
```shell
163
163
$ npm ci
164
164
```
165
165
@@ -170,13 +170,13 @@ This will install *all* the dependencies for p5.js; briefly, the most important
170
170
171
171
Once the dependencies are installed, use Grunt to run the unit tests.
172
172
173
-
```
173
+
```shell
174
174
$ grunt
175
175
```
176
176
177
177
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:
4. प्रोजेक्ट फ़ोल्डर में नेविगेट करें और npm के साथ अपनी सभी आवश्यक निर्भरताएं स्थापित करें।
68
68
69
-
```
69
+
```shell
70
70
$ cd p5.js
71
71
$ npm ci
72
72
```
73
73
74
74
5.[ग्रंट](https://gruntjs.com/) अब स्थापित किया जाना चाहिए, और आप इसका उपयोग स्रोत कोड से लाइब्रेरी बनाने के लिए कर सकते हैं।
75
75
76
-
```
76
+
```shell
77
77
$ npm run grunt
78
78
```
79
79
80
80
यदि आप लाइब्रेरी में लगातार फाइलों को बदल रहे हैं, तो आप अपने लिए लाइब्रेरी को स्वचालित रूप से पुनर्निर्माण करने के लिए `npm run dev` को चलाना चाहते हैं, जब भी इसका कोई भी सोर्स आपके बिना पहली बार मैन्युअल रूप से टाइप किए बिना बदल जाता है।
81
81
82
82
6. स्थानीय रूप से कोडबेस और [कमिट](https://help.github.com/articles/github-glossary/#commit) में कुछ बदलाव करें।
83
83
84
-
```
84
+
```shell
85
85
$ git add -u
86
86
$ git commit -m "YOUR COMMIT MESSAGE"
87
87
```
@@ -90,7 +90,7 @@ p5.js में योगदान देने में आपकी रुच
90
90
91
91
8.[पुश](https://help.github.com/articles/github-glossary/#push) गिटहब पर आपके फोर्क में आपके नए परिवर्तन।
92
92
93
-
```
93
+
```shell
94
94
$ git push
95
95
```
96
96
@@ -108,13 +108,13 @@ p5.js को स्वच्छ और शैलीगत सुसंगत क
108
108
109
109
त्रुटियों का पता लगाने के लिए, अपने टर्मिनल में निम्न कमांड चलाएँ (`$` प्रांप्ट टाइप न करें):
110
110
111
-
```
111
+
```shell
112
112
$ npm run lint
113
113
```
114
114
115
115
कुछ सिंटैक्स त्रुटियां स्वचालित रूप से ठीक की जा सकती हैं:
116
116
117
-
```
117
+
```shell
118
118
$ npm run lint:fix
119
119
```
120
120
@@ -136,7 +136,7 @@ $ npm run lint:fix
136
136
137
137
इकाई परीक्षण चलाने के लिए, आपको पहले परियोजना की निर्भरताएँ स्थापित करनी होंगी।
138
138
139
-
```
139
+
```shell
140
140
$ npm ci
141
141
```
142
142
@@ -147,13 +147,13 @@ $ npm ci
147
147
148
148
एक बार निर्भरताएं स्थापित हो जाने के बाद, यूनिट परीक्षणों को चलाने के लिए ग्रंट का उपयोग करें।
149
149
150
-
```
150
+
```shell
151
151
$ grunt
152
152
```
153
153
154
154
कभी-कभी कमांड लाइन पर के बजाय ब्राउज़र में परीक्षण चलाना उपयोगी होता है। ऐसा करने के लिए, पहले [कनेक्ट](https://github.com/gruntjs/grunt-contrib-connect) सर्वर शुरू करें:
Copy file name to clipboardExpand all lines: contributor_docs/hi/preparing_a_pull_request.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,21 +12,21 @@
12
12
### परिवर्तनों के बारे में जानें
13
13
सुनिश्चित करें कि आप अपस्ट्रीम p5.js रिपॉजिटरी को ट्रैक कर रहे हैं।
14
14
15
-
git remote show upstream
15
+
$ git remote show upstream
16
16
17
17
यदि आपको कोई त्रुटि दिखाई देती है, तो आपको "upstream" रिमोट रिपॉजिटरी के रूप में मुख्य p5.js रेपो को ट्रैक करना शुरू करना होगा। आपको केवल एक बार ऐसा करने की आवश्यकता होगी! लेकिन, अगर आप इसे दूसरी बार चलाते हैं तो कोई नुकसान नहीं होता है।
### शायद ज़रुरत पड़े- एक नई शाखा में अपने परिवर्तनों की एक प्रति बनाएँ
26
-
git branch your-branch-name-backup
26
+
$ git branch your-branch-name-backup
27
27
28
28
### मुख्य शाखा से परिवर्तन लागू करता है, *बाद में* अपने परिवर्तन जोड़ता है
29
-
git rebase upstream/main
29
+
$ git rebase upstream/main
30
30
31
31
### विवादों का समाधान
32
32
आपकी शाखा में कुछ उलझनें हो सकती हैं!
@@ -39,7 +39,7 @@
39
39
यदि आपके पास अन्य फ़ाइलों में विरोध है और आप सुनिश्चित नहीं हैं कि उन्हें कैसे हल किया जाए ... मदद के लिए पूछें!
40
40
41
41
### और अंत में, महान गौरव के लिए
42
-
git push origin
42
+
$ git push origin
43
43
44
44
यदि आप तकनीकी विवरणों के बारे में गहन जानकारी प्राप्त कर रहे हैं, तो रेबेसिंग पर एक अच्छा संदर्भ है। https://www.atlassian.com/git/tutorials/merging-vs-rebasing
@@ -80,7 +80,7 @@ Node.js परीक्षणों के लिए सेटअप सभी `
80
80
81
81
हम ```p5.prototype.isKeyPressed``` के लिए एक परीक्षण सूट बना सकते हैं और इसके लिए परीक्षण बनाना शुरू कर सकते हैं। हम अपने यूनिट परीक्षणों की संरचना के लिए Mocha का उपयोग करेंगे।
Copy file name to clipboardExpand all lines: contributor_docs/inline_documentation.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ You must specify one of these for the element to appear in the docs, with the na
16
16
* 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).
17
17
* Here is [yuidoc's reference](http://yui.github.io/yuidoc/syntax/index.html#basic-requirements) for more syntax information.
18
18
19
-
```
19
+
```js
20
20
/**
21
21
* The x component of the vector
22
22
* @property x
@@ -25,7 +25,7 @@ You must specify one of these for the element to appear in the docs, with the na
25
25
this.x= x ||0;
26
26
```
27
27
28
-
```
28
+
```js
29
29
30
30
/**
31
31
* Draw an arc
@@ -45,7 +45,7 @@ You must specify one of these for the element to appear in the docs, with the na
45
45
*/
46
46
```
47
47
48
-
```
48
+
```js
49
49
/**
50
50
*
51
51
* Calculates the magnitude (length) of the vector and returns the result
@@ -98,7 +98,7 @@ If the method returns the parent object, you can skip the `@return` and add this
98
98
99
99
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.
100
100
101
-
```
101
+
```js
102
102
/**
103
103
* @methodbackground
104
104
* @param{String}colorstring color string, possible formats include: integer
@@ -123,7 +123,7 @@ Notes:
123
123
124
124
Use `@final` if a property or variable is a constant:
125
125
126
-
```
126
+
```js
127
127
/**
128
128
* PI is a mathematical constant with the value 3.14159265358979323846.
129
129
* @property PI
@@ -135,7 +135,7 @@ Use `@final` if a property or variable is a constant:
135
135
136
136
Use `@private` if a property or variable is a private variable (default is `@public` so no need to specify).
137
137
138
-
```
138
+
```js
139
139
/**
140
140
* _start calls preload() setup() and draw()
141
141
*
@@ -149,7 +149,7 @@ Use `@private` if a property or variable is a private variable (default is `@pub
149
149
150
150
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.).
151
151
152
-
```
152
+
```js
153
153
/**
154
154
* @moduleimage
155
155
*/
@@ -163,7 +163,7 @@ define(function (require) {
163
163
164
164
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.
0 commit comments