Sync readme with contributing page on ecamp3.ch #4008
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DeNic0la
reviewed
Oct 22, 2023
README.md
Outdated
Comment on lines
25
to
37
| ### How can I help? | ||
|
|
||
| Thanks for helping! There are a few ways to get started. | ||
|
|
||
| - Visit our test environment at https://dev.ecamp3.ch. If you discover a bug, [open an issue](https://github.com/ecamp/ecamp3/issues/new) for it. | ||
| - To run the project on your computer for development, follow one of our installation guides: | ||
| - [Installation on Linux](https://github.com/ecamp/ecamp3/wiki/Development-install-on-linux) | ||
| - [Installation on Windows + WSL 2](https://github.com/ecamp/ecamp3/wiki/Development-installation-on-Windows) | ||
| - Visit our test environment at [https://dev.ecamp3.ch](https://dev.ecamp3.ch). If you discover a bug, [open a new issue for it](https://github.com/ecamp/ecamp3/issues/new). | ||
| - To run the project locally on your computer, follow one of the installation guides: | ||
| - [Installation with Docker on Linux](https://github.com/ecamp/ecamp3/wiki/Development-install-on-linux) | ||
| - [Installation with Docker on Windows + WSL2](https://github.com/ecamp/ecamp3/wiki/Development-installation-on-Windows) | ||
| - [Set up VS Code as your code editor](https://github.com/ecamp/ecamp3/wiki/Development-installation-on-Windows#setting-up-the-ide) | ||
| - If you run into problems during setup or need help, don't worry. Check the [discussions](https://github.com/ecamp/ecamp3/discussions) whether someone already had and solved your problem, and add a [new discussion](https://github.com/ecamp/ecamp3/discussions/new) otherwise. | ||
| - Before you can start coding, read our [contributing guidelines](CONTRIBUTING.md) | ||
| - Study the [documentation in the wiki](https://github.com/ecamp/ecamp3/wiki) | ||
| - Choose an [issue labeled "good first issue"](https://github.com/ecamp/ecamp3/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) and try to solve it | ||
| - If you encounter issues during setup or have questions, don't worry, you're not alone. Check the [discussions](https://github.com/ecamp/ecamp3/discussions) to see if your problem has already been addressed and solved. If not, open a [new discussion](https://github.com/ecamp/ecamp3/discussions/new). | ||
| - Before you start coding, read our [contributing guidelines](CONTRIBUTING.md). | ||
| - Familiarize yourself with the [documentation in the Wiki](https://github.com/ecamp/ecamp3/wiki). | ||
| - Choose an [issue labeled "good first issue"](https://github.com/ecamp/ecamp3/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) and try to solve it. |
There was a problem hiding this comment.
I think the setup-wiki-link should be moved to the CONTRIBUTING.md and the link to CONTRIBUTING.md should pop out a bit more. IMO you should head over to CONTRIBUTING.md before taking a look at the wiki. What do you think?
There was a problem hiding this comment.
Actually, so far your overhaul of the CONTRIBUTING.md in #3874 does not lead to the setup instructions in the wiki. So for now I have left these links in here. If you find a good spot in CONTRIBUTING.md to link to all the setup documentation, I think it would be a good idea to link more prominently from readme to contributing.
But in the current form of CONTRIBUTING.md, I think it isn't bad if someone reads a little in the wiki about the architecture (if we could ever get around to updating those pages) before actually trying to contribute a feature.
BacLuc
approved these changes
Oct 31, 2023
simfeld
approved these changes
Nov 14, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.