Skip to content

Commit

Permalink
Merge branch 'readme'
Browse files Browse the repository at this point in the history
  • Loading branch information
TimoDiepers committed May 2, 2024
2 parents 9228dfd + 8fb354f commit a6ef76a
Show file tree
Hide file tree
Showing 6 changed files with 409 additions and 56 deletions.
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Contributing

We welcome contributions! If you have any questions, you can [get in touch with the `timex_lca` developers ](mailto:timo.diepers@ltt.rwth-aachende.de)


## Contributing to the code, examples or documentation

If you want to contribute to the development our code with a new feature, want to share your timex-example or add to the documentation, please follow the [GitHub contribution workflow (fork, branch, PR)](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests) to share your work.

## Report bugs or errors

Something is not working as expected? You have two options:

### 🥈 Report an error
Please open a new issue in the `timex_lca` [repository](https://github.com/TimoDiepers/timex/issues), describing the error and where you found it.
A member of the timex_lca developer community will then take care of the issue, but it may take some time for your issue to be resolved.

### 🥇 Fix an error yourself
If you have a solution to the error, you can [create a fork](https://github.com/TimoDiepers/timex/forks) of the `timex_lca` repository, make your changes and [create a pull request](https://github.com/TimoDiepers/timex/pulls). The developers will assess the changes and be eternally grateful!

[code of conduct]: codeofconduct
16 changes: 1 addition & 15 deletions docs/content/contributing.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,3 @@
```{include} ../../CONTRIBUTING.md
```
# Contributing
```{note}
We are sorry to find you on this page! But we are happy to help you with your problem. Please follow the steps below to report a bug or error.
```

## 🥈 Report an error
Please open a new issue in the `timex_lca` [repository](https://github.com/TimoDiepers/timex/issues), describing the error and where you found it.
A member of the timex_lca developer community will then take care of the issue, but it may take some time for your issue to be resolved.

## 🥇 Fix an error yourself
If you have a solution to the error, you can create a fork of the `timex_lca` repository, make your changes and create a pull request. The developers will assess the changes and be eternally grateful!
Here is a description of the [GitHub contribution workflow (fork, branch, PR)](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests).

[code of conduct]: codeofconduct
```
128 changes: 128 additions & 0 deletions docs/content/data/example_ab_dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
218 changes: 218 additions & 0 deletions docs/content/data/example_ab_light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit a6ef76a

Please sign in to comment.