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
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ Hello! We welcome community contributions to the p5.js Web Editor. Contributing
18
18
19
19
## Code of Conduct
20
20
21
-
Please follow the guidelines in the [Code of Conduct](https://github.com/processing/p5.js-web-editor/blob/master/.github/CODE_OF_CONDUCT.md).
21
+
Please follow the guidelines in the [Code of Conduct](https://github.com/processing/p5.js-web-editor/blob/develop/.github/CODE_OF_CONDUCT.md).
22
22
23
23
## How Can I Contribute?
24
24
If you're new to open source, [read about how to contribute to open source](https://opensource.guide/how-to-contribute/).
@@ -60,7 +60,7 @@ If you feel like an issue is tagged incorrectly (e.g. it's low priority and you
60
60
61
61
If you'd like to work on an issue, please comment on it to let the maintainers know, so that they can assign it to you. If someone else has already commented and taken up that issue, please refrain from working on it and submitting a PR without asking the maintainers as it leads to unnecessary duplication of effort.
62
62
63
-
Then, look at the [development guide](https://github.com/processing/p5.js-web-editor/blob/master/developer_docs/development.md) for instructions on how to install the project locally and follow the right development workflow.
63
+
Then, look at the [development guide](https://github.com/processing/p5.js-web-editor/blob/develop/developer_docs/development.md) for instructions on how to install the project locally and follow the right development workflow.
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,5 +3,5 @@ Fixes #issue-number
3
3
I have verified that this pull request:
4
4
5
5
*[ ] has no linting errors (`npm run lint`)
6
-
*[ ] is from a uniquely-named feature branch and has been rebased on top of the latest master. (If I was asked to make more changes, I have made sure to rebase onto master then too)
7
-
*[ ] is descriptively named and links to an issue number, i.e. `Fixes #123`
6
+
*[ ] is from a uniquely-named feature branch and has been rebased on top of the latest `develop` branch. (If I was asked to make more changes, I have made sure to rebase onto `develop` then too)
7
+
*[ ] is descriptively named and links to an issue number, i.e. `Fixes #123`
Copy file name to clipboardExpand all lines: .github/config.yml
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -10,8 +10,8 @@ newIssueWelcomeComment: >
10
10
11
11
# Comment to be posted to on PRs from first time contributors in your repository
12
12
newPRWelcomeComment: >
13
-
🎉 Thanks for opening this pull request! Please check out our [contributing guidelines](https://github.com/processing/p5.js-web-editor/blob/master/.github/CONTRIBUTING.md) if you haven't already.
13
+
🎉 Thanks for opening this pull request! Please check out our [contributing guidelines](https://github.com/processing/p5.js-web-editor/blob/develop/.github/CONTRIBUTING.md) if you haven't already.
14
14
15
15
# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
16
16
17
-
# Comment to be posted to on pull requests merged by a first time user
17
+
# Comment to be posted to on pull requests merged by a first time user
@@ -23,7 +23,7 @@ All contributors to the p5.js Web Editor are expected to follow the [Code of Con
23
23
24
24
The p5.js Web Editor is a collaborative project created by many individuals, and you are invited to help. All types of involvement are welcome! Please check out the [contribution guide](./.github/CONTRIBUTING.md) for more details.
25
25
26
-
Developers, check the [developer docs](https://github.com/processing/p5.js-web-editor/blob/master/developer_docs/) details about contributing code, bug fixes, and documentation. To start writing code, a great place to start is the [development guide](https://github.com/processing/p5.js-web-editor/blob/master/developer_docs/development.md).
26
+
Developers, check the [developer docs](https://github.com/processing/p5.js-web-editor/blob/develop/developer_docs/) details about contributing code, bug fixes, and documentation. To start writing code, a great place to start is the [development guide](https://github.com/processing/p5.js-web-editor/blob/develop/developer_docs/development.md).
This folder contains documents intended for developers of the p5.js Web Editor.
2
2
3
3
## List of Documents
4
-
*[Contribution Guide](https://github.com/processing/p5.js-web-editor/blob/master/.github/CONTRIBUTING.md) - A place to get started!
4
+
*[Contribution Guide](https://github.com/processing/p5.js-web-editor/blob/develop/.github/CONTRIBUTING.md) - A place to get started!
5
5
*[Installation](installation.md) - A guide for setting up your development environment
6
6
*[Development](development.md) - A guide for adding code to the web editor
7
7
*[Preparing a pull-request](preparing_a_pull_request.md) - Instructions for how to make a pull-request
@@ -11,6 +11,6 @@ This folder contains documents intended for developers of the p5.js Web Editor.
11
11
*[Release](./release.md) - A guide to creating a production release.
Copy file name to clipboardExpand all lines: developer_docs/accessibility.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
@@ -8,13 +8,13 @@ The code for the p5.js web editor adheres to web accessibility standards. The fo
8
8
9
9
* Screen Readers are an assistive technology for vision loss which helps users to navigate a web page. They are able to prioritize content based on the semantic meaning of HTML tags. Therefore, it is important to use specific tags, such as `nav`, `ul`, `li`, `section`, and so on. `div` is the least screen reader friendly tag. For example, [here is the semantic meaning of the `body` tag](http://html5doctor.com/element-index/#body)
10
10
* All buttons/links/windows need to be accessible by the keyboard ( By tabbing, pressing space etc.)
11
-
* In cases where tags are not screen reader friendly, we can take advantage of [tabIndex](http://webaim.org/techniques/keyboard/tabindex). Using tabIndex ensures that all elements are accessible via keyboard. [code example](https://github.com/processing/p5.js-web-editor/blob/master/client/modules/IDE/components/Editor.jsx#L249)
12
-
* When opening a new window or pop up window, ensure the keyboard focus also moves to the new window. [code example](https://github.com/processing/p5.js-web-editor/blob/master/client/modules/IDE/components/NewFileForm.jsx#L16)
11
+
* In cases where tags are not screen reader friendly, we can take advantage of [tabIndex](http://webaim.org/techniques/keyboard/tabindex). Using tabIndex ensures that all elements are accessible via keyboard. [code example](https://github.com/processing/p5.js-web-editor/blob/develop/client/modules/IDE/components/Editor.jsx#L249)
12
+
* When opening a new window or pop up window, ensure the keyboard focus also moves to the new window. [code example](https://github.com/processing/p5.js-web-editor/blob/develop/client/modules/IDE/components/NewFileForm.jsx#L16)
13
13
14
14
**Labeling**
15
15
16
-
* When creating button icons, images, or something without text (this does not include an HTML5 `<button>`), use [aria-labels](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_aria-label_attribute). [code example](https://github.com/processing/p5.js-web-editor/blob/master/client/modules/IDE/components/Toolbar.jsx#L67)
17
-
* All `<table>`s need to have a `summary` attribute. This will ensure user is given context to what the table is. [code example](https://github.com/processing/p5.js-web-editor/blob/master/client/modules/IDE/components/SketchList.jsx#L39)
18
-
*`ul`s and `nav`s menus need to include a title. [code example](https://github.com/processing/p5.js-web-editor/blob/master/client/components/Nav.jsx#L7)
16
+
* When creating button icons, images, or something without text (this does not include an HTML5 `<button>`), use [aria-labels](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_aria-label_attribute). [code example](https://github.com/processing/p5.js-web-editor/blob/develop/client/modules/IDE/components/Toolbar.jsx#L67)
17
+
* All `<table>`s need to have a `summary` attribute. This will ensure user is given context to what the table is. [code example](https://github.com/processing/p5.js-web-editor/blob/develop/client/modules/IDE/components/SketchList.jsx#L39)
18
+
*`ul`s and `nav`s menus need to include a title. [code example](https://github.com/processing/p5.js-web-editor/blob/develop/client/components/Nav.jsx#L7)
19
19
20
-
For more information on accessibility see the [teach access tutorial](https://teachaccess.github.io/tutorial/)
20
+
For more information on accessibility see the [teach access tutorial](https://teachaccess.github.io/tutorial/)
Copy file name to clipboardExpand all lines: developer_docs/deployment.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ WIP.
17
17
18
18
These are the steps that happen when you deploy the application.
19
19
20
-
1. Push to `master` branch, or merge in a pull request to the `master` branch.
20
+
1. Push to `develop` branch, or merge in a pull request to the `develop` branch.
21
21
2. This triggers a build on [Travis CI](https://travis-ci.org/processing/p5.js-web-editor).
22
22
3. Travis CI builds a (development) Docker image of the whole application.
23
23
4. Travis CI runs some tests, which in this case, is just `npm run lint`. This could be updated in the future to include more extensive tests. If the tests fail, the build stops here.
@@ -46,7 +46,7 @@ _Note_: The installation steps assume you are using a Unix-like shell. If you ar
46
46
If you are interested in hosting and deploying your own p5.js Web Editor instance, you can! It would be the same as the official editor instance at editor.p5js.org, except with a different domain, and you would be in charge of the maintenance. We recommend using Heroku as you can host it for free.
47
47
48
48
1. Sign up for a free account at: [Heroku](https://www.heroku.com/)
Copy file name to clipboardExpand all lines: developer_docs/preparing_a_pull_request.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,11 +28,11 @@ Then ask git about the latest changes.
28
28
### Just in case: make a copy of your changes in a new branch
29
29
git branch your-branch-name-backup
30
30
31
-
### Apply changes from master branch, adds your changes *after*
32
-
git rebase upstream/master
31
+
### Apply changes from develop branch, adds your changes *after*
32
+
git rebase upstream/develop
33
33
34
-
### Switches back to master branch
35
-
git checkout master
34
+
### Switches back to develop branch
35
+
git checkout develop
36
36
37
37
### Helps other contributors fully understand the changes that you made
38
38
git commit -m "Fixed documentation typos"
@@ -41,7 +41,7 @@ Then ask git about the latest changes.
41
41
git status
42
42
43
43
## CONFLICTS
44
-
You may have some conflicts! It's okay. Feel free to ask for help. If merging with the latest upstream master causes conflicts, you can always make a pull request with the upstream repository, which makes the merge conflicts public.
44
+
You may have some conflicts! It's okay. Feel free to ask for help. If merging with the latest upstream `develop` branch causes conflicts, you can always make a pull request with the upstream repository, which makes the merge conflicts public.
Copy file name to clipboardExpand all lines: developer_docs/translations.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,8 @@ In order to simplify the translations process the following rules of thumb were
12
12
* There is only one file to translate all the texts in any specific language, which is located under the directory, in respective locale [subdirectory](https://github.com/processing/p5.js-web-editor/tree/develop/translations/locales)
13
13
* The new language code must be added to [client/i18n.js](https://github.com/processing/p5.js-web-editor/blob/develop/client/i18n.js#L7)
14
14
* New languages will need to be selected using a dropdown in Nav component, specifically in function [renderLanguageMenu.](https://github.com/processing/p5.js-web-editor/blob/develop/client/components/Nav.jsx#L550)
15
-
15
+
* Need to add `TRANSLATIONS_ENABLED=true` to `.env` to activate dropdown for the languages.
16
+
16
17
## Translations
17
18
18
19
* Every component should introduce its own subset of keys inside a dictionary named after the component.
0 commit comments