apluslms / aplus-manual

Download course templates to start building of a new course
MIT License
5 stars 28 forks source link

Add .editorconfig and docker-fast-compile.sh #29

Closed jaguarfi closed 4 years ago

jaguarfi commented 4 years ago

Description

Testing

The .editorconfig was tested in vim and VS Code.

The docker-fast-compile.sh was tested in the integrated terminal of VS Code and in a ubuntu terminal.

Have you updated the README or other relevant documentation?

We will need to add some description of the docker-fast-compile.sh in the course manual. Nonetheless, a description of these two new files was added in the new https://github.com/apluslms/aplus-course-template, which may be enough.

Is it Done?

jaguarfi commented 4 years ago

I took the https://github.com/apluslms/a-plus/blob/master/.editorconfig file as an example in order to keep consistency across projects. I basically added the settings for the rst files

raphendyr commented 4 years ago

P.s. I created a new upstream source to the correct place: https://apluslms.github.io/contribute/styleguides/ . It is done in a way that the common part could be updated from the upstream easily (i.e. local changes are at the end). Also I included a bit more generic info about parameters and plugins, but I think this repo could have more VSCode linking, as it's the succested editor currently. However, I would say no human reads this file normally.

markkuriekkinen commented 4 years ago

I was thinking that you would copy the upstream editorconfig file and add overrides to the end if this course-templates project needs to change some of the rules. Project-specific comments in the beginning can be added after the comments from the upstream.

jaguarfi commented 4 years ago

Ups! I did not realise that @raphendyr did changes to the file, and it seems like I did not read @Mankro comments thoroughly :man_facepalming:. Therefore, there is not much to add in this PR :). This PR basically copy the upstream .editorconfig file and copy it into this repository. However, in this PR, I wanted to rewrite the comments at the top of the file. If you think the changes in the comments should be also updated in the upstream, let me know, and I will create a PR for those changes. On the contrary, if you think that the comments are better in the current state, I will stick to those.