mirror of
https://github.com/enso-org/enso.git
synced 2024-12-19 00:31:39 +03:00
The IDE team process specification (https://github.com/enso-org/ide/pull/621)
Original commit: e9892d5645
This commit is contained in:
parent
d770f9b247
commit
0df765dcd5
@ -71,7 +71,7 @@ information and packages see [Enso repository](https://github.com/luna/enso).
|
|||||||
### Building
|
### Building
|
||||||
The project builds on MacOS, Linux, and Windows. Simply run `node ./run build`
|
The project builds on MacOS, Linux, and Windows. Simply run `node ./run build`
|
||||||
to build it and use `node ./run --help` to learn about other available commands
|
to build it and use `node ./run --help` to learn about other available commands
|
||||||
and options. Read the detailed [development guide](docs/contributing.md) to
|
and options. Read the detailed [development guide](docs/CONTRIBUTING.md) to
|
||||||
learn more.
|
learn more.
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
@ -95,7 +95,7 @@ highly appreciate every contribution. If you love the vision behind Enso and you
|
|||||||
want to redefine the data processing world, join us and help us track down bugs,
|
want to redefine the data processing world, join us and help us track down bugs,
|
||||||
implement new features, improve the documentation or spread the word! Join our
|
implement new features, improve the documentation or spread the word! Join our
|
||||||
community on a [Discord chat](http://chat.luna-lang.org) and read the
|
community on a [Discord chat](http://chat.luna-lang.org) and read the
|
||||||
[development and contributing guidelines](docs/contributing.md).
|
[development and contributing guidelines](docs/CONTRIBUTING.md).
|
||||||
|
|
||||||
<a href="https://github.com/luna/ide/graphs/contributors">
|
<a href="https://github.com/luna/ide/graphs/contributors">
|
||||||
<img src="https://opencollective.com/enso-language/contributors.svg?width=890&button=false" />
|
<img src="https://opencollective.com/enso-language/contributors.svg?width=890&button=false" />
|
||||||
|
@ -76,8 +76,8 @@ need the following setup:
|
|||||||
Please note that you should not use a code auto-formatter in this codebase. Please read the
|
Please note that you should not use a code auto-formatter in this codebase. Please read the
|
||||||
following documents to learn more about reasons behind this decision and the recommended code style
|
following documents to learn more about reasons behind this decision and the recommended code style
|
||||||
guide. Be sure to carefully read the
|
guide. Be sure to carefully read the
|
||||||
[Rust style guide 1](https://github.com/luna/ide/blob/main/docs/style-guide.md)
|
[Rust style guide 1](./contributing/style-guide.md)
|
||||||
and the [Rust style guide 2](https://github.com/luna/enso/blob/main/doc/style-guide/rust.md)
|
and the [Rust style guide 2](https://dev.enso.org/docs/style-guide/rust.html)
|
||||||
before contributing to the codebase.
|
before contributing to the codebase.
|
||||||
|
|
||||||
### Setting up Engine Services
|
### Setting up Engine Services
|
5
gui/docs/README.md
Normal file
5
gui/docs/README.md
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
# Enso IDE documentation
|
||||||
|
|
||||||
|
* [**Contributing guidelines**](./contributing/README.md) - helpful instructions for anyone who
|
||||||
|
wants to contribute.
|
||||||
|
* [**Product specification**](./product/README.md) - a specification from the user perspective.
|
7
gui/docs/contributing/README.md
Normal file
7
gui/docs/contributing/README.md
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
# Enso IDE Contributing Documentation
|
||||||
|
|
||||||
|
This directory contains helpful resources for anyone who wants to start Enso IDE development. The
|
||||||
|
main guideline is available [here](../CONTRIBUTING.md).
|
||||||
|
|
||||||
|
* [**Enso Team Process**](./process.md) - the development cycle in the core Enso IDE team.
|
||||||
|
* [**Style Guide**](./style-guide.md) - Our coding standards.
|
15
gui/docs/contributing/process.md
Normal file
15
gui/docs/contributing/process.md
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
# Enso IDE Team Process
|
||||||
|
|
||||||
|
This document specify our core team workflow, described as a lifecycle of a task:
|
||||||
|
|
||||||
|
* A newly created task should be appropriately described, but not estimated yet - it will be during
|
||||||
|
Backlog Refinement meeting. The task is put in "New Tasks" column.
|
||||||
|
* At the beginning of the sprint team leads put to the "To Refine" column all tasks which will be
|
||||||
|
refined during the next Backlog refinement.
|
||||||
|
* Each team member should read the descriptions of tasks in "To Refine" column and ask questions
|
||||||
|
and raise all concerns. All the conversation should be recorded in the issue's comments.
|
||||||
|
* During Backlog Refinement we confirm that the task description is clear and estimate it. The
|
||||||
|
estimate is expressed in work days of one person, and should include the review process. The task
|
||||||
|
is then moved to the "Backlog" column. If it turns out that there is no agreement about the task's
|
||||||
|
scope and estimation, it may be postponed to the next Backlog Refinement.
|
||||||
|
* During Planning meeting the team decides which tasks are took into next sprint and assign them.
|
7
gui/docs/product/README.md
Normal file
7
gui/docs/product/README.md
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
# Enso IDE Product Documentation
|
||||||
|
|
||||||
|
This section contains detailed specification of Enso IDE from the user perspective. The
|
||||||
|
implementation is documented in rust code and in the crate's `docs` directory.
|
||||||
|
|
||||||
|
* [**List of Shortcuts**](./shortcuts.md)
|
||||||
|
* [**Visualizations**](visualizations.md)
|
Loading…
Reference in New Issue
Block a user