Skip to content

Commit c07a70a

Browse files
committed
Update travis.yml with new branch names, add git flow to development and release guides
1 parent ec16905 commit c07a70a

File tree

5 files changed

+71
-43
lines changed

5 files changed

+71
-43
lines changed

.github/CONTRIBUTING.md

Lines changed: 1 addition & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ Hello! We welcome community contributions to the p5.js Web Editor. Contributing
1515
- [Issue Search and Tagging](#issue-search-and-tagging)
1616
- [Beginning Work](#beginning-work)
1717
- [Contribution Guides](#contribution-guides)
18-
- [Writing Commit Messages](#writing-commit-messages)
19-
- [Tips](#tips)
2018

2119
## Code of Conduct
2220

@@ -62,45 +60,9 @@ If you feel like an issue is tagged incorrectly (e.g. it's low priority and you
6260

6361
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.
6462

65-
Then, follow the [installation guide](https://github.com/processing/p5.js-web-editor/blob/master/developer_docs/installation.md) to get the project building and working on your computer.
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.
6664

6765
### Contribution Guides
6866

6967
* [https://guides.github.com/activities/hello-world/](https://guides.github.com/activities/hello-world/)
7068
* [https://guides.github.com/activities/forking/](https://guides.github.com/activities/forking/)
71-
72-
## Writing Commit Messages
73-
74-
Good commit messages serve at least three important purposes:
75-
76-
* They speed up the reviewing process.
77-
* They help us write good release notes.
78-
* They help future maintainers understand your change and the reasons behind it.
79-
80-
Structure your commit message like this:
81-
82-
```
83-
Short (50 chars or less) summary of changes ( involving Fixes #Issue-number keyword )
84-
85-
More detailed explanatory text, if necessary. Wrap it to about 72
86-
characters or so. In some contexts, the first line is treated as the
87-
subject of an email and the rest of the text as the body. The blank
88-
line separating the summary from the body is critical (unless you omit
89-
the body entirely); tools like rebase can get confused if you run the
90-
two together.
91-
92-
Further paragraphs come after blank lines.
93-
94-
- Bullet points are okay, too
95-
96-
- Typically a hyphen or asterisk is used for the bullet, preceded by a
97-
single space, with blank lines in between, but conventions vary here
98-
```
99-
100-
* Write the summary line and description of what you have done in the imperative mode, that is as if you were commanding someone. Start the line with "Fix", "Add", "Change" instead of "Fixed", "Added", "Changed".
101-
* Always leave the second line blank.
102-
* Be as descriptive as possible in the description. It helps reasoning about the intention of commits and gives more context about why changes happened.
103-
104-
## Tips
105-
106-
* If it seems difficult to summarize what your commit does, it may be because it includes several logical changes or bug fixes, and are better split up into several commits using `git add -p`.

.travis.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,12 @@ deploy:
3737
script: ./deploy.sh
3838
skip_cleanup: true
3939
on:
40-
branch: master
40+
branch: release
4141
- provider: script
4242
script: ./deploy_staging.sh
4343
skip_cleanup: true
4444
on:
45-
branch: feature/public-api
45+
branch: develop
4646

4747
env:
4848
global:

developer_docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This folder contains documents intended for developers of the p5.js Web Editor.
77
* [Preparing a pull-request](preparing_a_pull_request.md) - Instructions for how to make a pull-request
88
* [Accessibility Guidelines](accessibility.md) - Guidelines for writing code to create an accessible application
99
* [Deployment](deployment.md) - A guide to production deployment, and all platforms that are being used.
10+
* [Release](./release.md) - A guide to creating a production release.
1011

1112
## Documents to Create
1213
* Design Principles - reference [p5.js design principles](https://github.com/processing/p5.js/edit/master/contributor_docs/design_principles.md)

developer_docs/development.md

Lines changed: 56 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,74 @@
22

33
A guide for adding code to this project.
44

5+
- [Development](#development)
6+
- [Installation](#installation)
7+
- [Development Workflow](#development-workflow)
8+
- [Tests](#tests)
9+
- [Writing Git Commit Messages](#writing-git-commit-messages)
10+
- [Tips](#tips)
11+
- [Design](#design)
12+
- [Technologies Used](#technologies-used)
13+
514
## Installation
6-
Follow the [installation guide](https://github.com/processing/p5.js-web-editor/blob/master/developer_docs/installation.md).
15+
Follow the [installation guide](./installation.md).
16+
17+
## Development Workflow
18+
This project uses git-flow. For an in-depth overview of git-flow, read ["A successful Git branching model"](https://nvie.com/posts/a-successful-git-branching-model/). As a person contributing code but not creating production releases (this is most people!), here's what you need to know:
19+
* The default branch is `develop`. All pull requests should be made to this branch. It should be stable, and all commits are visible at a staging sever.
20+
* When working on a bug or feature, you should branch from the `develop` branch. When you're done, you should open a pull request from your feature branch to `develop`.
21+
* The `release` branch is the live production branch, and is the code deployed to editor.p5js.org. Changes to this branch should be made carefully, and will be done using git tags.
22+
* Emergency hotfix changes should be branched from `release` and merged via a pull request to `release`. After a PR is merged, then the commits can be merged to `develop`.
23+
24+
See the [release guide](./release.md) for information about creating a release.
725

826
## Tests
927
To run the test suite simply run `npm test` (after installing dependencies with `npm install`)
1028

1129
A sample unit test could be found here: [Nav.test.jsx](../client/components/__test__/Nav.test.jsx).
1230

31+
## Writing Git Commit Messages
32+
33+
Good commit messages serve at least three important purposes:
34+
35+
* They speed up the reviewing process.
36+
* They help us write good release notes.
37+
* They help future maintainers understand your change and the reasons behind it.
38+
39+
Structure your commit message like this:
40+
41+
```
42+
Short (50 chars or less) summary of changes ( involving Fixes #Issue-number keyword )
43+
44+
More detailed explanatory text, if necessary. Wrap it to about 72
45+
characters or so. In some contexts, the first line is treated as the
46+
subject of an email and the rest of the text as the body. The blank
47+
line separating the summary from the body is critical (unless you omit
48+
the body entirely); tools like rebase can get confused if you run the
49+
two together.
50+
51+
Further paragraphs come after blank lines.
52+
53+
- Bullet points are okay, too
54+
55+
- Typically a hyphen or asterisk is used for the bullet, preceded by a
56+
single space, with blank lines in between, but conventions vary here
57+
```
58+
59+
* Write the summary line and description of what you have done in the imperative mode, that is as if you were commanding someone. Start the line with "Fix", "Add", "Change" instead of "Fixed", "Added", "Changed".
60+
* Always leave the second line blank.
61+
* Be as descriptive as possible in the description. It helps reasoning about the intention of commits and gives more context about why changes happened.
62+
63+
### Tips
64+
65+
* If it seems difficult to summarize what your commit does, it may be because it includes several logical changes or bug fixes, and are better split up into several commits using `git add -p`.
66+
1367
## Design
1468
- [Style Guide/Design System on Figma](https://github.com/processing/p5.js-web-editor/labels/good%20medium%20issues)
1569
- [Latest Design on Figma](https://www.figma.com/file/5KychMUfHlq97H0uDsen1U/p5-web-editor-2017.p.copy?node-id=0%3A1). Note that the current design on the website has diverged, are parts of this design will not be implemented, but it is still helpful to have around for reference.
1670
- [Mobile Designs](https://www.figma.com/file/5KychMUfHlq97H0uDsen1U/p5-web-editor-2017.p.copy?node-id=0%3A2529), [Responsive Designs](https://www.figma.com/file/5KychMUfHlq97H0uDsen1U/p5-web-editor-2017.p.copy?node-id=0%3A3292)
1771

18-
# Technologies Used
72+
## Technologies Used
1973

2074
**MERN stack** - MongoDB, Express, React/Redux, and Node.
2175

developer_docs/release.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Release
2+
3+
A guide for creating a release.
4+
5+
## Background
6+
This project release guide is based on
7+
* [git-flow](https://nvie.com/posts/a-successful-git-branching-model/)
8+
* [Semantic Versioning (semver)](https://semver.org/)
9+
* [npm-version](https://docs.npmjs.com/cli/version)
10+
11+
## Steps

0 commit comments

Comments
 (0)