Skip to content

Commit f176a4b

Browse files
authored
docs: Update contributing guidelines for new simulations (builtree#152)
* docs: Updated README and home page * docs: Updated Contributing for new simulations
1 parent f853682 commit f176a4b

File tree

3 files changed

+8
-10
lines changed

3 files changed

+8
-10
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@
77

88
[![Gitter](https://badges.gitter.im/codEd-org/simulate.svg)](https://gitter.im/codEd-org/simulate?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
99

10-
Welcome to Simulate! Simulate is a collection of simulations and visualizations from various domains like mathematics, physics, computer science etc. in a cross platform app made using Flutter. The outcomes of these simulations mostly are really smooth (thanks to Flutter) and extremely beautiful (thanks to mathematics/sciences behind it).
10+
Welcome to Simulate! Simulate aims to be a collection of simulations and visualizations from various domains like mathematics, physics, computer science etc. in a cross platform app made using [Flutter](https://flutter.dev/).
11+
12+
You can find out more about Simulate and how it works or how you can share ideas and contribute to the project [here](https://cod-ed.github.io/simulate/).
1113

1214
<p align="center">
1315
<a href="https://cod-ed.github.io/simulate/web">
@@ -16,8 +18,6 @@ Welcome to Simulate! Simulate is a collection of simulations and visualizations
1618
</a>
1719
</p>
1820

19-
Find more information and documentation at https://cod-ed.github.io/simulate/
20-
2121
# Contributing
2222

2323
Before contributing, we highly recommend introducing yourself and your ideas on [gitter](https://gitter.im/codEd-org/simulate).

docs/contributing.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ git checkout -b [BRANCH NAME]
3232

3333
#### Adding a new Simulation:
3434

35-
1. Discuss the idea first on [gitter](https://gitter.im/codEd-org/simulate#) or just open an issue with the template.
36-
2. Discuss with the maintainers and get a simulation ID assigned.
37-
3. Build your simulation and open a PR!
35+
1. Got an idea? Discuss the idea on [gitter](https://gitter.im/codEd-org/simulate#) or just open an issue with this [template](https://github.com/cod-ed/simulate/issues/new?assignees=&labels=enhancement%2C+new+simulation%2C+simulations&template=simulation-request.md&title=simulation%3A+%5BSIMULATION+TITLE%5D). If the maintainers find it interesting, the issue will be labeled accepted. If you want to work on it and don't know how to implement it yet, we'll help you get it done.
36+
2. Even if you don't have an idea but are interested in working on one, checkout the [accepted simulation ideas](https://github.com/cod-ed/simulate/issues?q=is%3Aopen+is%3Aissue+label%3Aaccepted+label%3A%22new+simulation%22) and get assigned.
37+
3. You can start working now! Make sure you ask for help when needed, it's okay to get stuck.
3838

3939
---
4040

docs/index.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Simulate
22
[![Gitter](https://badges.gitter.im/codEd-org/simulate.svg)](https://gitter.im/codEd-org/simulate?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
33

4-
Welcome to Simulate! Simulate is a collection of simulations and visualizations from various domains like mathematics, physics, computer science etc. in a cross platform app made using Flutter. The outcomes of these simulations mostly are really smooth (thanks to Flutter) and extremely beautiful (thanks to mathematics/sciences behind it).
4+
Welcome to Simulate! Simulate aims to be a collection of simulations and visualizations from various domains like mathematics, physics, computer science etc. in a cross platform app made using [Flutter](https://flutter.dev/). The outcomes of these simulations mostly are really smooth (thanks to Flutter) and extremely beautiful (thanks to mathematics/sciences behind it).
55

66
<center>
77
[![Simulate for Web](https://raw.githubusercontent.com/cod-ed/assets/simulate/documentation/LaunchWebApp.svg){: style="width:300px"}](https://cod-ed.github.io/simulate/web){: target="_blank"}
@@ -11,8 +11,6 @@ Welcome to Simulate! Simulate is a collection of simulations and visualizations
1111

1212
## New to Simulate?
1313

14-
You can start by introducing yourself and your ideas on [gitter](https://gitter.im/codEd-org/simulate).
14+
You can start by introducing yourself and your ideas/doubts on [gitter](https://gitter.im/codEd-org/simulate).
1515

1616
Interested in Contributing? Check the guidelines [here](contributing/).
17-
18-
All further information about the can be found in the [documentation](doc/).

0 commit comments

Comments
 (0)