Skip to content

Commit

Permalink
Merge pull request #46 from citizen428/citizen428/spelling-fixes
Browse files Browse the repository at this point in the history
Fix grammar & spelling
  • Loading branch information
tmattio committed Feb 14, 2020
2 parents 548ab9e + 5bfeefa commit 121b601
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
12 changes: 6 additions & 6 deletions README.md
Expand Up @@ -30,7 +30,7 @@

🚀 Quickly start new projects that are ready for the real world.

❤️ Have a great developer experience when developping with Reason/OCaml.
❤️ Have a great developer experience when developing with Reason/OCaml.

🏄 Be as productive as Ruby-on-Rails or Elixir's Mix users.

Expand Down Expand Up @@ -133,7 +133,7 @@ npm install -g esy@latest

> NOTE: Make sure `esy --version` returns at least `0.5.8` for this project to build.
Then run the `esy` command from this project root to install and build depenencies.
Then run the `esy` command from this project root to install and build dependencies.

```bash
esy
Expand Down Expand Up @@ -227,7 +227,7 @@ The following snippet describes Spin's repository structure.
| Source for Spin's binary. This links to the library defined in `lib/`.
├── lib/
| Source for Spin's library. Contains Spin's core functionnalities.
| Source for Spin's library. Contains Spin's core functionalities.
├── test/
| Unit tests and integration tests for Spin.
Expand Down Expand Up @@ -257,12 +257,12 @@ The following snippet describes Spin's repository structure.
- Add more templates
- **data-science** - Data Science workflow.
- **desktop** - Native UI application using Revery.
- **graphl-api** - HTTP server that serves a GraphQL API.
- **graphql-api** - HTTP server that serves a GraphQL API.
- **rest-api** - HTTP server that serves a REST API.
- **react-components** - React component library with Storybook.
- **bs-bindings** - Bucklescript bindings to Javascript libraries.
- **bs-bindings** - BuckleScript bindings to Javascript libraries.
- Support more CI/CD
- Gitlab
- GitLab
- Azure
- Google Build
- Bitbucket Pipeline
Expand Down
6 changes: 3 additions & 3 deletions docs/naming-conventions.md
Expand Up @@ -2,7 +2,7 @@

You might notice that the naming conventions for the Reason syntax used in official Spin templates deviate from common communities practices.

When creating Spin, I wanted to develop a scaffolding tool for both OCaml and Reason. The communites diverge on several aspects, and naming conventions is only one of them. However, I wanted to consider Reason and OCaml as just syntaxic differences, so I had to unify a few things and go against some community common practices.
When creating Spin, I wanted to develop a scaffolding tool for both OCaml and Reason. The communities diverge on several aspects, and naming conventions is only one of them. However, I wanted to consider Reason and OCaml as just syntactic differences, so I had to unify a few things and go against some community common practices.

Among these unifications that might feel awkward to some people, we can list:

Expand All @@ -12,13 +12,13 @@ Among these unifications that might feel awkward to some people, we can list:

And finally, using snake case syntax for Reason.

I feel like this last point might make people unconfortable. I understand this very well because it felt unconfortable to me.
I feel like this last point might make people uncomfortable. I understand this very well because it felt uncomfortable to me.

The fact is, however, that changing Reason syntax to snake case seemed like a lesser sin than changing OCaml's syntax to camel case:

- Reason native projects depend heavily on other OCaml dependencies, so having camel case felt inconsistent
- On the same vein, Reason native projects use OCaml's standard library, which uses snake case
- Some Reason projects chosed not to follow the camel case conventions, one such example is morph.
- Some Reason projects chose not to follow the camel case conventions, one such example is morph.

Admittedly, I would personally prefer to use camel case, but consistency was more important to me.

Expand Down
4 changes: 2 additions & 2 deletions docs/why.md
@@ -1,7 +1,7 @@
# Why?

Reason and OCaml are by far my favourite languages! I've also worked on Elixir projects and saw with my own eyes how productive (and happy!) you can be with great toolings. I wish I had the best of both worlds: working with Reason and Ocaml and having a tooling worthy of Ruby-on-Rails.
Reason and OCaml are by far my favourite languages! I've also worked on Elixir projects and saw with my own eyes how productive (and happy!) you can be with great tooling. I wish I had the best of both worlds: working with Reason and Ocaml and having a tooling worthy of Ruby on Rails.

On another hand, I spend a large part of my time working on deployment pipelines, databases, micro-service communication, etc. It's hard to see how this aligns with the value of the product I work on, especially when it seems that I am doing the same things over and over again. I wanted to reduce the time I spend on this kind of thing.
On the other hand, I spend a large part of my time working on deployment pipelines, databases, micro-service communication, etc. It's hard to see how this aligns with the value of the product I work on, especially when it seems that I am doing the same things over and over again. I wanted to reduce the time I spend on this kind of thing.

Finally, another characteristic of Elixir and RoR ecosystems that I envy: all the projects have the same structure and use the same conventions. This is very powerful, and they achieve this by having official real-world templates. I hope Reason and OCaml communities will come to this one day, but of course, the community adoption of Spin is outside of my control, all I can do is build great templates that people enjoy! 😁

0 comments on commit 121b601

Please sign in to comment.