Browse Source

docs: add github issues link

assignment-operators
Garrit Franke 1 year ago
parent
commit
f00101a623
  1. 2
      README.md
  2. 2
      docs/developers/contributing.md

2
README.md

@ -10,7 +10,7 @@ It is meant to "just work", without adding unnecessary and bloated language feat
## State of this projects
Currently, Sabre is a general-purpose toy language. Its primary goal is to be simple and easy to understand, not to be efficient. Most algorithms should run fine, but some features may be unstable. Standard library and documentation are still incomplete. See [TODO](./TODO) for a roadmap.
Currently, Sabre is a general-purpose toy language. Its primary goal is to be simple and easy to understand, not to be efficient. Most algorithms should run fine, but some features may be unstable. Standard library and documentation are still incomplete. See the [open issues](https://github.com/garritfra/sabre/issues) for todos.
The Sabre compiler emits JavaScript, and a C backend is currently in development. Backends for WASM, x86 and ARM are planned.

2
docs/developers/contributing.md

@ -8,7 +8,7 @@ If you have a question, found a potential bug or want to engage with the communi
## Fixing things and adding features
If you want to contribute to the compiler itself, the easiest way to get started is to look at the [TODO file](https://github.com/garritfra/sabre/blob/master/TODO) at the root of the project. Usually, this is where important todo items are jotted down.
If you want to contribute to the compiler itself, the easiest way to get started is to look at the [open issues](https://github.com/garritfra/sabre/issues) of the project. Usually, this is where important todo items are jotted down and bugs are reported.
You could also run the tests (`cargo test`) and see if any tests are ignored. Usually, if a bug is found in the wild, a failing but ignored test is written, so that it can be further investigated later.

Loading…
Cancel
Save