Skip to content

Commit 8625777

Browse files
committed
Update readme and contributing instructions
1 parent 3cc3647 commit 8625777

File tree

2 files changed

+18
-5
lines changed

2 files changed

+18
-5
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
1+
# Contributing Guidelines
2+
3+
We really appreciate that you are considering contributing! There are many ways you can help us to improve the course material. The preferred way is to make a pull request, but you can also submit an issue, help with translations or review existing pull requests, for example.
4+
15
# Running Full stack open on your environment
26

37
1. Fork the repository
48
2. Clone your fork
59
3. Verify that you are running Node version 10 ([NVM](https://github.com/nvm-sh/nvm) recommended for managing node versions)
610
4. Install dependencies with `npm install`
711
5. Start the application with `npm start`
12+
6. Application will be available at <http://localhost:8000>
813

914
# Setting up the PR
1015

1116
1. Prettify your code with `npm run format`
1217
2. Create a new branch for your changes
1318
3. Create the PR from that branch to the source branch
19+
4. If your pull request is for a specific part of the course material, please add a corresponding label to your pull request (eg. "Part 3")
1420

1521
# Contributing with translations
22+
1623
When translation of a whole new part is completed, remember to update the file src/utils/translationProgress.json
1724
This file tracks the progress of translations, ranging from 0 (part0) to 13 (part13). It is used in the to avoid navigation errors when the user tries to access untranslated parts of the course. At the same time, it is used to automatically redirect the user to the English material (until the part is translated). So, if you have been working on a translation, remember to update this file after completing the translation of a whole part.

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
1-
# Full stack open
1+
# Full Stack Open
22

3-
Despite the repo name this is the current course repository.
3+
This repository contains the course material for the Full Stack Open online course. The material is available at <https://fullstackopen.com/>. Despite the name of the repository, this is the current course repository.
44

5-
<https://fullstackopen.com/>
5+
# How to Contribute
6+
7+
Did you find an error in the course material? Is something unclear? We highly value user contributions to improve our course content, and there are many ways you can help.
8+
9+
For detailed instructions on how to contribute, please read our [CONTRIBUTING.md](CONTRIBUTING.md) page.
10+
11+
# License
612

713
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/3.0/">
814
<img alt="Creative Commons -lisenssi" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/3.0/88x31.png"
915
/>
1016
</a>
11-
<br/> Materiaali on lisensoitu
12-
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/3.0/">Creative Commons BY-NC-SA 3.0 -lisenssillä</a>
17+
<br/> The material is licensed under the
18+
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/3.0/">Creative Commons BY-NC-SA 3.0 license</a>

0 commit comments

Comments
 (0)