Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add contribution instructions to README.md #125

Merged
merged 1 commit into from
Mar 3, 2022
Merged

Add contribution instructions to README.md #125

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Framework X – the simple and fast micro framework for building reactive web ap

* [Quickstart](#quickstart)
* [Documentation](#documentation)
* [Contribute](#contribute)
* [Tests](#tests)
* [License](#license)

Expand Down Expand Up @@ -73,6 +74,24 @@ Found a typo or want to contribute?
The website documentation is built from the source documentation files in
the [docs/](docs/) folder.

## Contribute

You want to contribute to the Framework X source code or documentation? You've
come to the right place!

To contribute to the source code just locate the [src/](src/) folder and you'll find all
content in there. Additionally, our [tests/](tests/) folder contains all our unit
tests and acceptance tests to assure our code works as expected. For more
information on how to run the test suite check out our [testing chapter](#tests).

If you want to contribute to the [documentation](#documentation) of Framework X
found on the website, take a look inside the [docs/](docs/) folder. You'll find further
instructions inside the `README.md` in there.

Found a typo on our [website](https://framework-x.org/)? Simply go to our
[website repository](https://github.com/clue/framework-x-website)
and follow the instructions found in the `README`.

## Tests

To run the test suite, you first need to clone this repo and then install all
Expand Down