-
-
Notifications
You must be signed in to change notification settings - Fork 292
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
cfe528c
commit ebac468
Showing
12 changed files
with
160 additions
and
223 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# Contribute to Roc | ||
|
||
## Community Values | ||
|
||
<!-- | ||
Work in Progress - Richard is developing this section | ||
Basically it will say something like we expect you to be kind, even if you think someone is being mean to you, don't assume ill intentions etc | ||
--> | ||
|
||
## Meet the Community | ||
|
||
- Group Chat [roc.zulipchat.com](https://roc.zulipchat.com/) | ||
- Github Project [roc-lang/roc](https://github.com/roc-lang/roc) | ||
- Meetups & Events | ||
|
||
## Ideas & Proposals | ||
|
||
- [Good First Issues](https://github.com/roc-lang/roc/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) | ||
|
||
<!-- | ||
In this section we want to explain the process, i.e. it's less formal | ||
TODO finish editing this section | ||
--> | ||
|
||
Roc doesn't have a formal process for managing design proposals. The guiding principal for now is that as a community we should all be friendly, supportive, and openly discuss and sharing ideas. | ||
|
||
There are three loose stages that a design proposal can go through in Roc: Idea, Proposal, and Implementation. | ||
|
||
In the Idea stage, people are encouraged to describe their idea and explore the problem, potential solutions, and trade-offs. It is helpful to share the idea in the group chat using the #ideas channel. | ||
|
||
If there is a general consensus that an idea is promising and worth developing, people are encouraged to develop a design Proposal. Some ideas are simple and should progress straight to implementation. However, for more complex Proposals a it write the design into an article or blog post and share it online. This documentation helps in clarifying the proposal and making it more accessible to the community. | ||
|
||
Implementation using PR... | ||
|
||
## Code of Conduct | ||
|
||
<!-- link to github goes here --> |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
|
||
# Design Goals | ||
|
||
<!-- | ||
This page outlines at a high level of abstraction the design goals for Roc, and provides an assessment/overview of current progress | ||
The three goals are Fast, Friendly, and Functional | ||
- communicate the key selling points of Roc | ||
- essence that sets the language apart | ||
TODO move content from current home page, update for current progress | ||
--> | ||
|
||
# Fast | ||
|
||
<!-- | ||
more universal appeal | ||
don't take this for granted, drive this, it doesn't happen automatically | ||
making lists of things -- maybe someday we can automatically optimise, we would like people to take the extra time to think about this | ||
give people the tools to measure performance | ||
benchmarking?? | ||
--> | ||
|
||
# Friendly | ||
|
||
<!-- | ||
encouraging community values - e.g. designing a library | ||
immersed in the friendliness | ||
testing?? | ||
--> | ||
|
||
# Functional | ||
|
||
<!-- | ||
if your already a fan | ||
for others, some people find it unfamiliar and maybe even negative (don't assume this is automatically a positive) - don't worry | ||
--> |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Documentation | ||
|
||
- Builtin Package <!-- link to builtins --> | ||
- Basic-CLI Platform <!-- link to docs --> | ||
|
||
<!-- TODO Develop a Short language reference, move stuff out of tutorial e.g. de-sugaring table, keywords --> | ||
|
||
## Guides | ||
|
||
- [Frequently Asked Questions](https://github.com/roc-lang/roc/blob/main/FAQ.md) | ||
- [Roc for Elm Programmers](https://github.com/roc-lang/roc/blob/main/roc-for-elm-programmers.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Sponsor | ||
|
||
- [Github Sponsorship](https://github.com/sponsors/roc-lang) | ||
|
||
<!-- | ||
1. link to github sponsor | ||
2. have your company sponsor Roc | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Tutorial | ||
|
||
This is a placeholder page for the Roc tutorial. | ||
|
||
TODO move the tutorial here from `../generate_tutorial/src/input/tutorial.roc` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters