Skip to content

Commit bc4658f

Browse files
committed
Add suggestions to CONTRIBUTING.md
1 parent a919c55 commit bc4658f

2 files changed

Lines changed: 10 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,3 +66,12 @@ Make use of the many generators for code, try `ember help generate` for more det
6666
* Ember logo
6767
* Otherwise, try to keep the overall theme as close to other Ember websites as possible.
6868

69+
### Suggestions
70+
71+
* Try to only fix one issue and/or upgrade one version. You are more likely to be able to succeed.
72+
* Upgrading the ember-cli version is extremely difficult, because we are using private apis. Try to upgrade in small pieces. Consider forking ember-cli during the upgrade process to upgrade its dependencies one by one. Don't forget to revert to a standard ember-cli version when done.
73+
* Add tests with your PR.
74+
* Upgrading ember-cli is usually not necessary to upgrade Ember or Ember Data.
75+
* New Ember versions will not work without upgrades to the backend.
76+
* The backend does not have tests. Until it does, please test by actually compiling addons with Docker and an AWS account before submitting PRs.
77+
* If you are going to use a local backend, make changes to environment.js using [`git update-index skip-worktree [<file>...]`](https://medium.com/@igloude/git-skip-worktree-and-how-i-used-to-hate-config-files-e84a44a8c859) so that changes to your environment.js are not accidentally committed.

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ An ember cli like web based javascript sharing tool. http://ember-twiddle.com
66

77
* Ember Twiddle uses [Github Gists](https://gist.github.com) as persistence layer. Once you hit `Save` on a newly created Twiddle, it will create a public Gist under your Github account.
88
* If you'd like to help out, check out [CONTRIBUTING.md](CONTRIBUTING.md) We are looking for help maintaining the project. If you have contributed and would like to be made a maintainer, please make a request on the Slack channel or via email.
9+
* Ember Twiddle uses a backend for compiling addons. It is currently located at https://github.com/joostdevries/twiddle-backend
910

1011
### Browser support
1112

0 commit comments

Comments
 (0)