create contributing guide, move code of conduct to separate file, add issue template
This commit is contained in:
Cassie Tarakajian
parent
6b02ef196a
commit
7d93900852
4 changed files with 71 additions and 31 deletions
23
CODE_OF_CONDUCT.md
Normal file
23
CODE_OF_CONDUCT.md
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
# p5.js Code of Conduct
|
||||
|
||||
* **Be mindful of your language.** Any of the following behavior is unacceptable:
|
||||
* Offensive comments related to gender identity and expression, sexual orientation, race, ethnicity, language, neuro-type, size, ability, class, religion, culture, subculture, political opinion, age, skill level, occupation, or background
|
||||
* Threats of violence
|
||||
* Deliberate intimidation
|
||||
* Sexually explicit or violent material
|
||||
* Unwelcome sexual attention
|
||||
* Stalking or following
|
||||
* Or any other kinds of harassment
|
||||
|
||||
Use your best judgement. If it will possibly make others uncomfortable, do not post it.
|
||||
|
||||
* **Be respectful.** Disagreement is not an opportunity to attack someone else's thoughts or opinions. Although views may differ, remember to approach every situation with patience and care.
|
||||
* **Be considerate.** Think about how your contribution will affect others in the community.
|
||||
* **Be open minded.** Embrace new people and new ideas. Our community is continually evolving and we welcome positive change.
|
||||
|
||||
If you believe someone is violating the code of conduct, we ask that you report it by emailing [hello@p5js.org](mailto:hello@p5js.org). Please include your name and a description of the incident, and we will get back to you ASAP.
|
||||
|
||||
Participants asked to stop any harassing behavior are expected to comply immediately. If a participant engages in harassing behavior, the p5.js Team may take any action they deem appropriate, up to and including expulsion from all p5.js spaces and identification of the participant as a harasser to other p5.js members or the general public.
|
||||
|
||||
## Also
|
||||
* You can read our [community statement](http://p5js.org/community/) on our website.
|
||||
28
ISSUE_TEMPLATE.md
Normal file
28
ISSUE_TEMPLATE.md
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
<!--
|
||||
Hi there! If you are here to report a bug, or to discuss a feature (new or existing), you can use the below template to get started quickly. Fill out all those parts which you're comfortable with, and delete the remaining ones.
|
||||
|
||||
To check any option, replace the "[ ]" with a "[x]". Be sure to check out how it looks in the Preview tab!
|
||||
|
||||
Feel free to remove any portion of the template that is not relevant for your issue.
|
||||
-->
|
||||
|
||||
#### Nature of issue?
|
||||
|
||||
- [ ] Found a bug
|
||||
- [ ] Existing feature enhancement
|
||||
- [ ] New feature request
|
||||
|
||||
<!-- If you found a bug, the following information might prove to be helpful for us. Simply remove whatever you can't determine/don't know. -->
|
||||
#### Details about the bug:
|
||||
|
||||
- Web browser and version: <!-- On Chrome/FireFox/Opera you can enter "about:" in the address bar to find out the version -->
|
||||
- Operating System: <!-- Ex: Windows/MacOSX/Linux along with version -->
|
||||
- Steps to reproduce this:
|
||||
<!-- Include a simple code snippet that demonstrates the problem, along with any console errors produced. If this isn't possible, then simply describe the issue as best you can! Feel free to link to the web editor or include pictures or a video. -->
|
||||
|
||||
<!-- If you want to enhance an existing feature, please describe here, otherwise remove this section -->
|
||||
#### Feature enhancement details:
|
||||
|
||||
|
||||
<!-- If you want to request a new feature, please describe here, otherwise remove this section -->
|
||||
#### New feature details:
|
||||
26
README.md
26
README.md
|
|
@ -4,13 +4,14 @@ This project is currently in development! It will be announced when there is a (
|
|||
|
||||
## Development Installation
|
||||
|
||||
1. Clone this repostory and cd into it
|
||||
2. `$ git submodule init`
|
||||
3. `$ npm install`
|
||||
4. Install MongoDB and make sure it is running
|
||||
1. Fork this repository.
|
||||
2. Clone the forked repostory and cd into it
|
||||
3. `$ git submodule init`
|
||||
4. `$ npm install`
|
||||
5. Install MongoDB and make sure it is running
|
||||
* For Mac OSX with [homebrew](http://brew.sh/): `brew install mongodb` then `brew services start mongodb`
|
||||
* For Windows and Linux: [MongoDB Installation](https://docs.mongodb.com/manual/installation/)
|
||||
5. Create a file called `.env` in the root of this directory that looks like
|
||||
6. Create a file called `.env` in the root of this directory that looks like
|
||||
|
||||
```
|
||||
API_URL=/api
|
||||
|
|
@ -26,10 +27,10 @@ This project is currently in development! It will be announced when there is a (
|
|||
```
|
||||
If you don't care about being able to upload media files to S3 or Login with Github, you can drop in the file exactly how it is. Or, if you don't want to do that, just ask me to send you mine. Refer to [this gist](https://gist.github.com/catarak/70c9301f0fd1ac2d6b58de03f61997e3) for creating an S3 bucket for testing, or if you don't want to do that, I can add you to one of my S3 buckets.
|
||||
|
||||
6. `$ npm run fetch-examples` - this downloads the example sketches into a user called 'p5'
|
||||
7. `$ npm start`
|
||||
8. Navigate to [http://localhost:8000](http://localhost:8000) in your browser
|
||||
9. Install the [React Developer Tools](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en).
|
||||
7. `$ npm run fetch-examples` - this downloads the example sketches into a user called 'p5'
|
||||
8. `$ npm start`
|
||||
9. Navigate to [http://localhost:8000](http://localhost:8000) in your browser
|
||||
10. Install the [React Developer Tools](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en).
|
||||
10. Open and close the Redux DevTools using `ctrl+h`, and move them with `ctrl+w`
|
||||
|
||||
### Testing SSL on your local machine
|
||||
|
|
@ -91,8 +92,11 @@ The code for the p5.js web editor adheres to web accessibility standards. The fo
|
|||
|
||||
For more information on accessibility see the [teach access tutorial](https://teachaccess.github.io/tutorial/)
|
||||
|
||||
## Contribution Guide
|
||||
I am currently open to contributors! Email me if you are looking for a task, or look at the open issues and reply that you are working on a task.
|
||||
## Contributing
|
||||
|
||||
See [CONTRIBUTING.md](https://github.com/processing/p5.js-web-editor/blob/master/contributing.md).
|
||||
|
||||
## Tooling and Style Overview
|
||||
|
||||
The p5.js Web Editor is built on a MERN stack - MongoDB, Express, React/Redux, and Node. For a reference to the file structure format I am using, please look at the [Mern Starter](https://github.com/Hashnode/mern-starter) and [this comment](https://github.com/Hashnode/mern-starter/issues/90#issuecomment-221553573).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,24 +1,9 @@
|
|||
# p5.js Code of Conduct
|
||||
# Contributing to the p5.js web editor
|
||||
|
||||
* **Be mindful of your language.** Any of the following behavior is unacceptable:
|
||||
* Offensive comments related to gender identity and expression, sexual orientation, race, ethnicity, language, neuro-type, size, ability, class, religion, culture, subculture, political opinion, age, skill level, occupation, or background
|
||||
* Threats of violence
|
||||
* Deliberate intimidation
|
||||
* Sexually explicit or violent material
|
||||
* Unwelcome sexual attention
|
||||
* Stalking or following
|
||||
* Or any other kinds of harassment
|
||||
We welcome community contributions to the p5.js web editor! You can contribute even if you are not a developer by documenting bugs, proposing new features, and updating documentation.
|
||||
|
||||
Use your best judgement. If it will possibly make others uncomfortable, do not post it.
|
||||
When opening an issue, be sure to clearly describe the issue, task, or feature. If it is a bug, try to include steps to reproduce or other contextual information, such as the browser or operating system.
|
||||
|
||||
* **Be respectful.** Disagreement is not an opportunity to attack someone else's thoughts or opinions. Although views may differ, remember to approach every situation with patience and care.
|
||||
* **Be considerate.** Think about how your contribution will affect others in the community.
|
||||
* **Be open minded.** Embrace new people and new ideas. Our community is continually evolving and we welcome positive change.
|
||||
Feel free to work on any open issue, though make sure you reply that you are working on it. first-timers-only and help-wanted tagged issues are coming soon :smile:
|
||||
|
||||
If you believe someone is violating the code of conduct, we ask that you report it by emailing [hello@p5js.org](mailto:hello@p5js.org). Please include your name and a description of the incident, and we will get back to you ASAP.
|
||||
|
||||
Participants asked to stop any harassing behavior are expected to comply immediately. If a participant engages in harassing behavior, the p5.js Team may take any action they deem appropriate, up to and including expulsion from all p5.js spaces and identification of the participant as a harasser to other p5.js members or the general public.
|
||||
|
||||
## Also
|
||||
* You can read our [community statement](http://p5js.org/community/) on our website.
|
||||
* Check out the [development](https://github.com/processing/p5.js/wiki/Development) wiki page for more in-depth details about contributing code, bug fixes, and documentation.
|
||||
To begin development follow the steps in [README.md](https://github.com/processing/p5.js-web-editor#development-installation) to install the project locally.
|
||||
|
|
|
|||
Loading…
Reference in a new issue