From 117b5bca634d2d0a822635ba12195582db63ed93 Mon Sep 17 00:00:00 2001 From: Cassie Tarakajian Date: Thu, 9 Dec 2021 17:00:23 -0500 Subject: [PATCH 1/2] Update README to match p5.js, change developer_docs to contributor_docs --- .github/CONTRIBUTING.md | 8 +-- README.md | 28 ++++----- .../README.md | 0 .../accessibility.md | 0 .../deployment.md | 0 .../development.md | 0 .../installation.md | 0 .../preparing_a_pull_request.md | 0 .../public_api.md | 0 .../public_api_proposed.md | 0 .../release.md | 0 .../testing.md | 0 .../translations.md | 0 package-lock.json | 58 +++++++++++++++---- translations/ko/CONTRIBUTING.md | 4 +- translations/ko/README.md | 2 +- 16 files changed, 65 insertions(+), 35 deletions(-) rename {developer_docs => contributor_docs}/README.md (100%) rename {developer_docs => contributor_docs}/accessibility.md (100%) rename {developer_docs => contributor_docs}/deployment.md (100%) rename {developer_docs => contributor_docs}/development.md (100%) rename {developer_docs => contributor_docs}/installation.md (100%) rename {developer_docs => contributor_docs}/preparing_a_pull_request.md (100%) rename {developer_docs => contributor_docs}/public_api.md (100%) rename {developer_docs => contributor_docs}/public_api_proposed.md (100%) rename {developer_docs => contributor_docs}/release.md (100%) rename {developer_docs => contributor_docs}/testing.md (100%) rename {developer_docs => contributor_docs}/translations.md (100%) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 06adec0923..75fd595459 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -35,9 +35,9 @@ Don't know where to begin? Here are some suggestions to get started: - Translations: Application and documentation * Use the [p5.js Web Editor](https://editor.p5js.org)! Find a bug? Think of something you think would add to the project? Open an issue. * Expand an existing issue. Sometimes issues are missing steps to reproduce, or need suggestions for potential solutions. Sometimes they need another voice saying, "this is really important!" -* Try getting the project running locally on your computer by following the [installation steps](./../developer_docs/installation.md). -* Look through the documentation in the [developer docs](../developer_docs/). Is there anything that could be expanded? Is there anything missing? -* Look at the [development guide](./../developer_docs/development.md). +* Try getting the project running locally on your computer by following the [installation steps](./../contributor_docs/installation.md). +* Look through the documentation in the [developer docs](../contributor_docs/). Is there anything that could be expanded? Is there anything missing? +* Look at the [development guide](./../contributor_docs/development.md). ### Good First Issues For first-time contributors or those who want to start with a small task, [check out the list of good first issues](https://github.com/processing/p5.js-web-editor/labels/good%20first%20issue), or [issues that need documentation of steps to reproduce](https://github.com/processing/p5.js-web-editor/issues?q=is%3Aissue+is%3Aopen+label%3A%22needs+steps+to+reproduce%22). If the issue has not been assigned to anyone, then you can work on it! It's okay to not know how to fix an issue, and feel free to ask questions about to approach the problem! We are all here to learn and make something awesome. Someone from the community would help you out and these are great issues for learning about the web editor, its file structure and its development process. @@ -60,7 +60,7 @@ If you feel like an issue is tagged incorrectly (e.g. it's low priority and you 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. -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. +Then, look at the [development guide](https://github.com/processing/p5.js-web-editor/blob/develop/contributor_docs/development.md) for instructions on how to install the project locally and follow the right development workflow. ### Contribution Guides diff --git a/README.md b/README.md index d12bb7f7a0..26b07ec862 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# [p5.js Web Editor](https://editor.p5js.org) +# [p5.js Editor](https://editor.p5js.org) Documentation is also available in the following languages: @@ -7,29 +7,23 @@ Documentation is also available in the following languages: ## Welcome! πŸ‘‹πŸ‘‹πŸΏπŸ‘‹πŸ½πŸ‘‹πŸ»πŸ‘‹πŸΎπŸ‘‹πŸΌ -The p5.js Web Editor is a platform for creative coding, with a focus on making coding accessible for as many people as possible, including artists, designers, educators, beginners, and anyone who wants to learn. Simply by opening the website you can get started writing p5.js sketches without downloading or configuring anything. The editor is designed with simplicity in mind by limiting features and frills. We strive to listen to the community to drive the editor’s development, and to be intentional with every change. The editor is free and open-source. - -We also strive to give the community as much ownership and control as possible. You can download your sketches so that you can edit them locally or host them elsewhere. You can also host your own version of the editor, giving you control over its data. +The p5.js Editor is a website for creating p5.js sketches, with a focus on making coding accessible and inclusive for artists, designers, educators, beginners, and anyone else! You can create, share, or remix p5.js sketches without needing to download or configure anything. It is designed with beginners in mind, limiting features and frills. The editor is free and open-source because we believe software, and the tools to learn it, should be accessible to everyone. ## Community -New to the p5.js community? Read our [community statement](https://p5js.org/community/). - -## Code of Conduct +We are a community of, and in solidarity with, people from every gender identity and expression, sexual orientation, race, ethnicity, language, neuro-type, size, ability, class, religion, culture, subculture, political opinion, age, skill level, occupation, and background. We acknowledge that not everyone has the time, financial means, or capacity to actively participate, but we recognize and encourage involvement of all kinds. We facilitate and foster access and empowerment. We are all learners. -All contributors to the p5.js Web Editor are expected to follow the [Code of Conduct](./.github/CODE_OF_CONDUCT.md). We strive to create a friendly and safe community! +The p5.js Editor is a collaborative project created by many individuals, mostly volunteers, and you are invited to help. All types of involvement are welcome. See the [community section](https://p5js.org/community) to get started! You can also check out the [contributor docs](./contributor_docs/README.md) for more in-depth details about contributing to different areas of the project, including code, bug fixes, documentation, discussion, and more. -## Get Involved +Learn more about [our community](https://p5js.org/community/) and read our community statement and [code of conduct](./.github/CODE_OF_CONDUCT.md). You can directly support our work with p5.js by [donating to the Processing Foundation](https://processingfoundation.org/support). -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. +## Get Started -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). +Make your first sketch in the [p5.js Editor](https://editor.p5js.org/)! Learn more about sketching with p5.js on the [Get Started](https://p5js.org/get-started/) and find everything you can do in the [Reference](https://p5js.org/reference/). You can also look at [examples](https://editor.p5js.org/p5/sketches) and remix them in the p5.js Editor. ## Issues -If you have found a bug in the p5.js Web Editor, you can file it under the ["issues" tab](https://github.com/processing/p5.js-web-editor/issues). - -Please post bugs and feature requests in the correct repository: +If you have found a bug in the p5.js Web Editor, you can file it under the ["issues" tab](https://github.com/processing/p5.js-web-editor/issues). You can also request new features here. A set of templates for reporting issues and requesting features are provided to assist you (and us!). The p5.js Editor is maintained mostly by volunteers, so we thank you for your patience as we try to address your issues as soon as we can. Please post bugs and feature requests in the correct repository if you can: * p5.js library: [https://github.com/processing/p5.js/issues](https://github.com/processing/p5.js/issues) * p5.accessibility: [https://github.com/processing/p5.accessibility/issues](https://github.com/processing/p5.accessibility/issues) @@ -38,8 +32,8 @@ Please post bugs and feature requests in the correct repository: ## Acknowledgements -Support for this project has come from [Processing Foundation](https://processingfoundation.org/), [NYU ITP](https://tisch.nyu.edu/itp), and [CS4All, NYC DOE](http://cs4all.nyc/). +Support for this project has come from [Processing Foundation](https://processingfoundation.org/), [NYU ITP](https://tisch.nyu.edu/itp), [CS4All, NYC DOE](http://cs4all.nyc/), [COSA at DU](https://liberalarts.du.edu/emergent-digital-practices/open-source-arts), [STUDIO for Creative Inquiry](https://studioforcreativeinquiry.org/), [Grant for the Web](https://www.grantfortheweb.org/), [New Media Rights](https://www.newmediarights.org/), and many others. Hosting and technical support has come from:
- - + + diff --git a/developer_docs/README.md b/contributor_docs/README.md similarity index 100% rename from developer_docs/README.md rename to contributor_docs/README.md diff --git a/developer_docs/accessibility.md b/contributor_docs/accessibility.md similarity index 100% rename from developer_docs/accessibility.md rename to contributor_docs/accessibility.md diff --git a/developer_docs/deployment.md b/contributor_docs/deployment.md similarity index 100% rename from developer_docs/deployment.md rename to contributor_docs/deployment.md diff --git a/developer_docs/development.md b/contributor_docs/development.md similarity index 100% rename from developer_docs/development.md rename to contributor_docs/development.md diff --git a/developer_docs/installation.md b/contributor_docs/installation.md similarity index 100% rename from developer_docs/installation.md rename to contributor_docs/installation.md diff --git a/developer_docs/preparing_a_pull_request.md b/contributor_docs/preparing_a_pull_request.md similarity index 100% rename from developer_docs/preparing_a_pull_request.md rename to contributor_docs/preparing_a_pull_request.md diff --git a/developer_docs/public_api.md b/contributor_docs/public_api.md similarity index 100% rename from developer_docs/public_api.md rename to contributor_docs/public_api.md diff --git a/developer_docs/public_api_proposed.md b/contributor_docs/public_api_proposed.md similarity index 100% rename from developer_docs/public_api_proposed.md rename to contributor_docs/public_api_proposed.md diff --git a/developer_docs/release.md b/contributor_docs/release.md similarity index 100% rename from developer_docs/release.md rename to contributor_docs/release.md diff --git a/developer_docs/testing.md b/contributor_docs/testing.md similarity index 100% rename from developer_docs/testing.md rename to contributor_docs/testing.md diff --git a/developer_docs/translations.md b/contributor_docs/translations.md similarity index 100% rename from developer_docs/translations.md rename to contributor_docs/translations.md diff --git a/package-lock.json b/package-lock.json index 6a7a301ee6..de2ac8587f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -7083,7 +7083,8 @@ }, "ssri": { "version": "7.1.0", - "resolved": "", + "resolved": "https://registry.npmjs.org/ssri/-/ssri-7.1.0.tgz", + "integrity": "sha512-77/WrDZUWocK0mvA5NTRQyveUf+wsrIc6vyrxpS8tVvYBcX215QbafrJR3KtkpskIzoFLqqNuuYQvxaMjXJ/0g==", "dev": true, "requires": { "figgy-pudding": "^3.5.1", @@ -9196,7 +9197,8 @@ }, "browserslist": { "version": "4.16.1", - "resolved": "", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.16.1.tgz", + "integrity": "sha512-UXhDrwqsNcpTYJBTZsbGATDxZbiVDsx6UjpmRUmtnP10pr8wAYr5LgFoEFw9ixriQH2mv/NX2SfGzE/o8GndLA==", "dev": true, "requires": { "caniuse-lite": "^1.0.30001173", @@ -12435,7 +12437,8 @@ }, "kind-of": { "version": "6.0.2", - "resolved": "" + "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.2.tgz", + "integrity": "sha512-s5kLOcnH0XqDO+FvuaLX8DDjZ18CGFk7VygH40QoKPUQhW4e2rvM0rwUq0t8IQDOwYSeLK01U90OjzBTme2QqA==" } } }, @@ -12588,7 +12591,8 @@ "dependencies": { "ansi-regex": { "version": "5.0.0", - "resolved": "", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz", + "integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==", "dev": true }, "ansi-styles": { @@ -18897,7 +18901,8 @@ }, "ini": { "version": "1.3.5", - "resolved": "", + "resolved": "https://registry.npmjs.org/ini/-/ini-1.3.5.tgz", + "integrity": "sha512-RZY5huIKCMRWDUqZlEi72f/lmXKMvuszcMBduliQ3nnWbx9X/ZBQO7DijMEYS9EhHBb2qacRUMtC7svLwe0lcw==", "optional": true }, "is-fullwidth-code-point": { @@ -27222,6 +27227,12 @@ "package-json": "^6.3.0" } }, + "lazy-cache": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/lazy-cache/-/lazy-cache-1.0.4.tgz", + "integrity": "sha1-odePw6UEdMuAhF07O24dpJpEbo4=", + "dev": true + }, "lazy-universal-dotenv": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/lazy-universal-dotenv/-/lazy-universal-dotenv-3.0.1.tgz", @@ -28451,7 +28462,8 @@ }, "merge-deep": { "version": "3.0.2", - "resolved": "", + "resolved": "https://registry.npmjs.org/merge-deep/-/merge-deep-3.0.2.tgz", + "integrity": "sha512-T7qC8kg4Zoti1cFd8Cr0M+qaZfOwjlPDEdZIIPPB2JZctjaPM4fX+i7HOId69tAti2fvO6X5ldfYUONDODsrkA==", "dev": true, "requires": { "arr-union": "^3.1.0", @@ -28468,6 +28480,7 @@ "for-own": "^0.1.3", "is-plain-object": "^2.0.1", "kind-of": "^3.0.2", + "lazy-cache": "^1.0.3", "shallow-clone": "^0.1.2" } }, @@ -28479,7 +28492,8 @@ "requires": { "is-extendable": "^0.1.1", "kind-of": "^2.0.1", - "lazy-cache": "^0.2.3" + "lazy-cache": "^0.2.3", + "mixin-object": "^2.0.1" }, "dependencies": { "kind-of": { @@ -28847,6 +28861,24 @@ } } }, + "mixin-object": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/mixin-object/-/mixin-object-2.0.1.tgz", + "integrity": "sha1-T7lJRB2rGCVA8f4DW6YOGUel5X4=", + "dev": true, + "requires": { + "for-in": "^0.1.3", + "is-extendable": "^0.1.1" + }, + "dependencies": { + "for-in": { + "version": "0.1.8", + "resolved": "https://registry.npmjs.org/for-in/-/for-in-0.1.8.tgz", + "integrity": "sha1-2Hc5COMSVhCZUrH9ubP6hn0ndeE=", + "dev": true + } + } + }, "mjml": { "version": "3.3.5", "resolved": "https://registry.npmjs.org/mjml/-/mjml-3.3.5.tgz", @@ -29963,7 +29995,8 @@ "dependencies": { "ansi-regex": { "version": "5.0.0", - "resolved": "", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz", + "integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==", "dev": true }, "ansi-styles": { @@ -38276,7 +38309,8 @@ }, "kind-of": { "version": "6.0.2", - "resolved": "" + "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.2.tgz", + "integrity": "sha512-s5kLOcnH0XqDO+FvuaLX8DDjZ18CGFk7VygH40QoKPUQhW4e2rvM0rwUq0t8IQDOwYSeLK01U90OjzBTme2QqA==" } } }, @@ -39375,7 +39409,8 @@ }, "ansi-regex": { "version": "5.0.0", - "resolved": "", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz", + "integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==", "dev": true }, "emoji-regex": { @@ -42653,7 +42688,8 @@ "dependencies": { "ansi-regex": { "version": "5.0.0", - "resolved": "", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz", + "integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==", "dev": true }, "emoji-regex": { diff --git a/translations/ko/CONTRIBUTING.md b/translations/ko/CONTRIBUTING.md index c66131b89e..1562eac923 100644 --- a/translations/ko/CONTRIBUTING.md +++ b/translations/ko/CONTRIBUTING.md @@ -36,7 +36,7 @@ * [p5.js μ›Ή 에디터](https://editor.p5js.org)λ₯Ό μ‚¬μš©ν•΄λ³΄μ„Έμš”! 버그λ₯Ό μ°ΎμœΌμ…¨λ‚˜μš”? 이 ν”„λ‘œμ νŠΈμ— λ­”κ°€λ₯Ό λ”ν•˜μ‹€ 수 μžˆμ„ 것 κ°™μœΌμ‹ κ°€μš”? κ·Έλ ‡λ‹€λ©΄ 이슈λ₯Ό μ—΄μ–΄μ£Όμ„Έμš”. * κΈ°μ‘΄ μ΄μŠˆλ“€μ„ ν™•μž₯μ‹œμΌœλ³΄μ„Έμš”. 가끔은 μ΄μŠˆλ“€ 쀑에 μž¬ν˜„ 과정이 λ―Έν‘ν•˜κ±°λ‚˜, μ†”λ£¨μ…˜ 후보듀이 ν•„μš”ν•œ κ²½μš°λ“€μ΄ μžˆμŠ΅λ‹ˆλ‹€. μ–΄μ©” 땐 β€œμ΄κ±° 정말 μ€‘μš”ν•΄!” ν•˜κ³  λ§ν•΄μ£ΌλŠ” λͺ©μ†Œλ¦¬κ°€ ν•„μš”ν•œ κ²½μš°λ“€λ„ μžˆμŠ΅λ‹ˆλ‹€. * μ—¬λŸ¬λΆ„μ˜ 둜컬 μ»΄ν“¨ν„°μ—μ„œ [μ„€μΉ˜ 단계](./installation.md)λ₯Ό 따라 ν”„λ‘œμ νŠΈλ₯Ό μ‹€ν–‰ν•΄λ³΄μ„Έμš”. -* [개발자 λ¬Έμ„œ 디렉토리](./../../developer_docs/) μ•ˆμ˜ λ¬Έμ„œλ“€μ„ μ½μ–΄λ³΄μ„Έμš”. 더 ν™•μž₯될 수 μžˆλŠ” λ­”κ°€κ°€ μžˆλ‚˜μš”? λ­”κ°€ λΉ μ§„κ²Œ μžˆλ‚˜μš”? +* [개발자 λ¬Έμ„œ 디렉토리](./../../contributor_docs/) μ•ˆμ˜ λ¬Έμ„œλ“€μ„ μ½μ–΄λ³΄μ„Έμš”. 더 ν™•μž₯될 수 μžˆλŠ” λ­”κ°€κ°€ μžˆλ‚˜μš”? λ­”κ°€ λΉ μ§„κ²Œ μžˆλ‚˜μš”? * [개발 κ°€μ΄λ“œ](./development.md)λ₯Ό μ½μ–΄λ³΄μ„Έμš”. ### 쒋은 첫 μ΄μŠˆλ“€ @@ -60,7 +60,7 @@ μ–΄λ–€ 이슈λ₯Ό μœ„ν•œ μž‘μ—…μ„ μ‹œμž‘ν•˜κ³  μ‹Άλ‹€λ©΄, ν•΄λ‹Ή μ΄μŠˆμ— λŒ“κΈ€μ„ λ‹¬μ•„μ„œ κ΄€λ¦¬μžλ“€μ—κ²Œ 이λ₯Ό μ•Œλ € 이슈λ₯Ό ν• λ‹Ή λ°›μœΌμ‹œκΈ° λ°”λžλ‹ˆλ‹€. λ§Œμ•½ λ‹€λ₯Έ μ‚¬λžŒμ΄ 이미 ν•΄λ‹Ή μ΄μŠˆμ— λŒ“κΈ€μ„ λ‹¬μ•˜κ³  μž‘μ—…μ„ ν•˜κΈ°λ‘œ λ˜μ–΄ μžˆλ‹€λ©΄, λΆˆν•„μš”ν•œ 쀑볡 문제λ₯Ό ν”Όν•˜κΈ° μœ„ν•΄ ν•΄λ‹Ή μ΄μŠˆμ™€ κ΄€λ ¨λœ μž‘μ—…μ„ ν•˜κ±°λ‚˜ κ΄€λ¦¬μžμ—κ²Œ 묻지 μ•Šμ€ μ±„λ‘œ ν’€ λ¦¬ν€˜μŠ€νŠΈλ₯Ό μ œμΆœν•˜λŠ” 일은 μ‚Όκ°€μ£Όμ‹œκΈ° λ°”λžλ‹ˆλ‹€. -이제 μ—¬λŸ¬λΆ„μ˜ μ»΄ν“¨ν„°μ—μ„œ ν”„λ‘œμ νŠΈλ₯Ό λΉŒλ“œν•˜κ³  μž‘μ—…μ„ ν•˜κΈ° μœ„ν•΄ [μ„€μΉ˜ κ°€μ΄λ“œ](https://github.com/processing/p5.js-web-editor/blob/develop/developer_docs/installation.md)λ₯Ό 따라 μ£Όμ‹œκΈ° λ°”λžλ‹ˆλ‹€. +이제 μ—¬λŸ¬λΆ„μ˜ μ»΄ν“¨ν„°μ—μ„œ ν”„λ‘œμ νŠΈλ₯Ό λΉŒλ“œν•˜κ³  μž‘μ—…μ„ ν•˜κΈ° μœ„ν•΄ [μ„€μΉ˜ κ°€μ΄λ“œ](https://github.com/processing/p5.js-web-editor/blob/develop/contributor_docs/installation.md)λ₯Ό 따라 μ£Όμ‹œκΈ° λ°”λžλ‹ˆλ‹€. ### κΈ°μ—¬ κ°€μ΄λ“œ diff --git a/translations/ko/README.md b/translations/ko/README.md index 413e9aad74..453ad38717 100644 --- a/translations/ko/README.md +++ b/translations/ko/README.md @@ -16,7 +16,7 @@ p5.js μ›Ή μ—λ””ν„°μ˜ λͺ¨λ“  μ»¨νŠΈλ¦¬λ·°ν„°λ“€μ€ λ‹€μŒμ˜ [행동 μˆ˜μΉ™](./ p5.js μ›Ή μ—λ””ν„°λŠ” λ‹€μˆ˜μ˜ κ°œμΈλ“€μ— μ˜ν•΄ λ§Œλ“€μ–΄μ§„ ν˜‘λ ₯ ν”„λ‘œμ νŠΈμ΄λ©°, μ—¬λŸ¬λΆ„ μ—­μ‹œ 도움을 μ£Όμ‹€ 수 μžˆμŠ΅λ‹ˆλ‹€. λͺ¨λ“  μ’…λ₯˜μ˜ μ°Έμ—¬λ₯Ό ν™˜μ˜ν•©λ‹ˆλ‹€! 더 μžμ„Έν•œ 사항을 μœ„ν•΄μ„œλŠ” [κΈ°μ—¬ μ•ˆλ‚΄](./.github/CONTRIBUTING.md)λ₯Ό ν™•μΈν•˜μ‹œκΈ° λ°”λžλ‹ˆλ‹€. -개발자 뢄듀은 μ½”λ“œ κΈ°μ—¬, 버그 μˆ˜μ •, λ¬Έμ„œν™”μ— λŒ€ν•œ μ„ΈλΆ€ 사항을 [개발자 λ¬Έμ„œ](https://github.com/processing/p5.js-web-editor/blob/develop/developer_docs/)μ—μ„œ ν™•μΈν•˜μ‹œκΈ° λ°”λžλ‹ˆλ‹€. μ½”λ“œ μž‘μ„±μ„ μ‹œμž‘ν•˜κΈ° μœ„ν•œ 쒋은 μ‹œμž‘μ μ€ [개발 μ•ˆλ‚΄](https://github.com/processing/p5.js-web-editor/blob/develop/developer_docs/development.md)λ₯Ό μ‚΄νŽ΄λ³΄λŠ” κ²ƒμž…λ‹ˆλ‹€. +개발자 뢄듀은 μ½”λ“œ κΈ°μ—¬, 버그 μˆ˜μ •, λ¬Έμ„œν™”μ— λŒ€ν•œ μ„ΈλΆ€ 사항을 [개발자 λ¬Έμ„œ](https://github.com/processing/p5.js-web-editor/blob/develop/contributor_docs/)μ—μ„œ ν™•μΈν•˜μ‹œκΈ° λ°”λžλ‹ˆλ‹€. μ½”λ“œ μž‘μ„±μ„ μ‹œμž‘ν•˜κΈ° μœ„ν•œ 쒋은 μ‹œμž‘μ μ€ [개발 μ•ˆλ‚΄](https://github.com/processing/p5.js-web-editor/blob/develop/contributor_docs/development.md)λ₯Ό μ‚΄νŽ΄λ³΄λŠ” κ²ƒμž…λ‹ˆλ‹€. ## 이슈 From 44487ed81f90b4a4a81ba1885e7a692e4feab9ee Mon Sep 17 00:00:00 2001 From: Cassie Tarakajian Date: Fri, 10 Dec 2021 15:55:16 -0500 Subject: [PATCH 2/2] Update issue template and pull request template --- .github/ISSUE_TEMPLATE.md | 27 ------------------- .../existing-feature-enhancement.md | 18 +++++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 22 +++++++++++++++ .github/ISSUE_TEMPLATE/found-a-bug.md | 22 +++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 5 +++- .../{ => contributor_docs}/ko/CONTRIBUTING.md | 0 .../{ => contributor_docs}/ko/README.md | 0 7 files changed, 66 insertions(+), 28 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/existing-feature-enhancement.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/found-a-bug.md rename translations/{ => contributor_docs}/ko/CONTRIBUTING.md (100%) rename translations/{ => contributor_docs}/ko/README.md (100%) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 3750f16fec..0000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,27 +0,0 @@ - - -#### Nature of issue? - - - -- Found a bug -- Existing feature enhancement -- New feature request - - -#### Details about the bug: - -- Web browser and version: -- Operating System: -- Steps to reproduce this bug: - - - - -#### Feature enhancement details: - - - -#### New feature details: \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/existing-feature-enhancement.md b/.github/ISSUE_TEMPLATE/existing-feature-enhancement.md new file mode 100644 index 0000000000..9f36e11dc3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/existing-feature-enhancement.md @@ -0,0 +1,18 @@ +--- +name: Existing Feature Enhancement +about: This template is for suggesting an improvement for an existing feature. +title: '' +labels: enhancement +assignees: '' + +--- + + + +### How would this new feature help [increase access](https://github.com/processing/p5.js/blob/main/contributor_docs/access.md) to the p5.js Editor? + +#### Feature enhancement details: diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 0000000000..699cdd64d8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,22 @@ +--- +name: New Feature Request +about: This template is for requesting a new feature be added. +title: '' +labels: feature request +assignees: '' + +--- + + + +### How would this new feature help [increase access](https://github.com/processing/p5.js/blob/main/contributor_docs/access.md) to the p5.js Editor? + +#### New feature details: diff --git a/.github/ISSUE_TEMPLATE/found-a-bug.md b/.github/ISSUE_TEMPLATE/found-a-bug.md new file mode 100644 index 0000000000..73c508416e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/found-a-bug.md @@ -0,0 +1,22 @@ +--- +name: Found a Bug +about: This template is for reporting bugs (broken or incorrect behavior). If you have questions about your own code, please visit our forum discourse.processing.org instead. +title: '' +labels: bug +assignees: '' + +--- + + + +#### Details about the bug: + +- p5.js version: +- Web browser and version: +- Operating System: +- Steps to reproduce this: + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index efbfd96924..1f457785f4 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,7 +1,10 @@ Fixes #issue-number +Changes: + I have verified that this pull request: * [ ] has no linting errors (`npm run lint`) -* [ ] 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) +* [ ] has no test errors (`npm run test`) +* [ ] is from a uniquely-named feature branch and is up to date with the `develop` branch. * [ ] is descriptively named and links to an issue number, i.e. `Fixes #123` diff --git a/translations/ko/CONTRIBUTING.md b/translations/contributor_docs/ko/CONTRIBUTING.md similarity index 100% rename from translations/ko/CONTRIBUTING.md rename to translations/contributor_docs/ko/CONTRIBUTING.md diff --git a/translations/ko/README.md b/translations/contributor_docs/ko/README.md similarity index 100% rename from translations/ko/README.md rename to translations/contributor_docs/ko/README.md