You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-12
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,22 @@
1
1
# Components Section
2
2
3
-
Repository for the microbit playground [components section](https://microbit-playground.co.uk/components/).
3
+
The microbit playground website is built from these repositories on github:
4
4
5
-
This repository is checked out at build time. There is a `draft` branch and a `publish` branch. All changes should be made to the `draft` branch and merged into publish with a squash.
You can add a page to the website by adding to the repository.
11
+
12
+
This repository is checked out at build time. There is a `draft` branch and a `publish` branch. All changes should be made to the `draft` branch.
13
+
14
+
## Contributing
8
15
See [the page on the website](https://microbit-playground.co.uk/about/how-to-contribute). Submissions are welcome.
9
16
10
17
Submit an issue if you have an idea for an article.
11
18
12
-
#####A Contribution Should...
19
+
### A Contribution Should...
13
20
* Not contain fixes or additions to existing articles; please use 'Issues'.
14
21
* Be a pull request to the `draft` branch.
15
22
* Have a `720x420px``.png` teaser image in `/teaser/`.
@@ -18,29 +25,30 @@ Submit an issue if you have an idea for an article.
18
25
* Licensed images used are mentioned in the `YAML` frontmatter of the `.md` file in the `acknowledgements` field if required.
19
26
* Nothing too spammy or marketty or Google juicy.
20
27
21
-
######Optional
22
-
* For public attribution on the website, add your name and details to the author repository.
28
+
### Optional
29
+
* For public attribution on the website, add your name and details to the [author repository](https://github.com/microbit-playground/author-database).
23
30
24
-
######A Brief Note
31
+
## A Brief Note
25
32
Github is very rude! I do not mean the people but github.com. Picture the scene: you spend an age writing an article and are filled with pride and goodness about helping kids & adults learn. When I review and start to edit it, __rejected__ or __changes requested__ appears!
26
33
27
34
Perhaps this works fine in some areas but I know there is an emotional attachment when writing learning resources.
28
35
29
-
So please, do please translate these messages from robot into Human.
36
+
So please, do please translate these message from robot into Human.
37
+
30
38
31
-
###Files in Repository
39
+
## Files in Repository
32
40
The website's pages are generated from `.md` files in the main directory. The name of each `.md` file has a corresponding image in `/teaser/` of the same name.
33
41
34
42
*`/images/` -- Images used in the article.
35
43
*`/teaser/` -- Directory for teaser images & video.
0 commit comments