Bath Wiki - Recent changes [en-gb]

BOSS/Languages

Pm2022 — Wed, 26 Aug 2026 07:13:29 GMT

cat

← Older revision		Revision as of 07:13, 26 August 2026
Line 74:		Line 74:

	So basically in summary write documentation and follow the language's style!		So basically in summary write documentation and follow the language's style!
			[[Category:Bath Open Source Society]]

Category:Programming language guidelines

Pm2022 — Wed, 26 Aug 2026 07:11:51 GMT

Created blank page

New page

BOSS/Languages

Pm2022 — Wed, 26 Aug 2026 07:11:34 GMT

improve clarity, link to language guidance

← Older revision		Revision as of 07:11, 26 August 2026
Line 1:		Line 1:
	~~As this is for students, we want to allow students to~~ use whatever language they feel most comfortable with, ~~especially due to our~~ security and code quality standards.		Students should use whatever language they feel most comfortable with, as this helps maintain security and code quality standards.

	~~However having said that we want a~~ consistent style throughout the projects ~~(which~~ is ~~quite difficult with so many people working on that)~~. So for each language we have used in the past we have written up some code quality guidelines.		A consistent style throughout the projects is desireable. So for each language we have used in the past we have written up some code quality and style guidelines.

	If you are going to write in a new language, please follow the general code quality guidelines below.		If you are going to write in a new language, please follow the general code quality guidelines below.
Line 7:		Line 7:
	== Recommendations ==		== Recommendations ==

	~~And now as any pedantic programmer, I will give my recommendations~~ for ~~you to be using~~.		=== Language-specific guidance ===

			You can find quality and style guides for specific programming languages in [[:Category:Programming language guidelines]].

	=== Static Sites ===		=== Static Sites ===

	For static sites ~~we ask that you don’t use a programming language and instead~~ use a static site generator like [https://gohugo.io/ hugo] and write the pages in ~~markdown~~.		For static sites it is best to use a static site generator like [https://gohugo.io/ hugo] and write the pages in Markdown.

	This ~~is just to help the simplicity of~~ the page and ~~make~~ it much easier to edit for non-technical people, while also meaning we don’t use Wordpress (it’s insecure).		This keeps the page simple and makes it much easier to edit for non-technical people, while also meaning we don’t use Wordpress (it’s insecure).

	Some static site generators:		Some static site generators:
Line 23:		Line 25:
	=== Other Projects ===		=== Other Projects ===

	~~We recommend using~~ a language ~~which suites~~ the ~~purposes~~ of your project. ~~As most projects will be~~ websites, ~~we recommend using a language~~ with a good ~~library for this. These include~~:		Always use a language that suits the purpose of your project. For websites, here are some recommendations for languages with good web development support:

	* Rust (using [https://rocket.rs/ rocket])		* Rust (using [https://rocket.rs/ rocket])
Line 30:		Line 32:
	* Any other sane type safe language		* Any other sane type safe language

	Languages and combos that are not good for this purpose, due to the lack of type safety or ~~insecurity~~:		Languages and combos that are not good for this purpose, due to the lack of type safety or security:

	* TypeScript (unless ~~its~~ just for the frontend or utilising a package which performs runtime type validation)		* TypeScript (unless it's just for the frontend or utilising a package which performs runtime type validation)
	* Python		* Python
	* Perl		* Perl
	* JavaScript (use TypeScript instead for our sanity) - ~~this does not include~~ small scripts for pages.		* JavaScript (use TypeScript instead for our sanity) - except small scripts for pages.
	* Ruby (does not implement some parts of http request spec correctly)		* Ruby (does not implement some parts of http request spec correctly)
	* PHP (due to being run as root in most circumstances, this has significant security vulnerabilities). If you don’t know what this means, look up web shells, almost all of them are PHP so it’s better just not to even have the possibility of being compatible with them.		* PHP (due to being run as root in most circumstances, this has significant security vulnerabilities). If you don’t know what this means, look up web shells, almost all of them are PHP so it’s better just not to even have the possibility of being compatible with them.
Line 48:		Line 50:
	As we don’t have requirements on what language you should be using, we have some general code quality guidelines.		As we don’t have requirements on what language you should be using, we have some general code quality guidelines.

	However for the languages we have projects in we have written more specific code guidelines.		However for the languages we have projects in we have written more specific code guidelines (see [[:Category:Programming language guidelines]]).

	<ul>		<ul>
Line 71:		Line 73:
	<li><p>Trailing commas when the bracket on a new line</p></li></ul>		<li><p>Trailing commas when the bracket on a new line</p></li></ul>

	So basically in summary write documentation and follow the ~~language’s~~ style!		So basically in summary write documentation and follow the language's style!

BOSS/Languages/TypeScript

Pm2022 — Wed, 26 Aug 2026 07:03:39 GMT

Pm2022 moved page BOSS/Languages/TypeScript to TypeScript

New page

Again, please in most cases use TypeScript over JavaScript.

== Overview ==

This should mostly be done by [https://biomejs.dev/ biome] or [https://prettier.io/ prettier] and [https://eslint.org/ eslint], but so you know

<ul>
<li>Try to prioritise readability of code</li>
<li>2 spaces as tabs</li>
<li>Lines should not be longer than 80 characters (install extension)</li>
<li>Trailing commas when the bracket on a new line</li>
<li>NO trailing whitespaces! (Install an extension to remove it for you)</li>
<li>Space after comments e.g. <code>// something</code></li>
<li>Order imports alphabetically</li>
<li>Prefer documentation over comments (see below on how you do that)</li>
<li>Comments should only be written when necessary, mainly to describe why something is done the way it is or to example a really unreadable bit of code (however this normally means you should change the code).</li>
<li>Methods should be ordered alphabetically (with private methods ordered separately and at the bottom of the file)
<syntaxhighlight lang="js">export function aFunc() {}
export function bFunc() {}
export function zFunc() {}
function aPrivateFunc() {}
function bPrivateFunc() {}</syntaxhighlight></li></ul>

These are really strict, if you take anything away remember this:

* Use a formatter and linter: styling should be consistent throughout the project
* Readability of code takes precedent

=== Use a Linter ===

Linters usually will catch most issues, these can be installed as extensions to your preferred editor. E.g. for TypeScript we will be using [https://biomejs.dev/ biome] or [https://eslint.org/ ESLint].

For Biome, both formatting and linting can be configured with <code>biome.json</code>:<syntaxhighlight lang="json">
{
"$schema": "https://biomejs.dev/schemas/2.4.15/schema.json",
"vcs": {
"enabled": true,
"clientKind": "git",
"useIgnoreFile": true
},
"files": {
"includes": ["**", "!!**/dist"]
},
"formatter": {
"enabled": true,
"indentWidth": 2,
"indentStyle": "space"
},
"linter": {
"enabled": true,
"rules": {
"recommended": true
}
},
"javascript": {
"formatter": {
"quoteStyle": "double"
}
},
"assist": {
"enabled": true,
"actions": {
"source": {
"organizeImports": "on"
}
}
},
"css": {
"parser": {
"tailwindDirectives": true
}
},
"overrides": [
{
"includes": ["**/*.svelte", "**/*.astro", "**/*.vue"],
"linter": {
"rules": {
"style": {
"useConst": "off",
"useImportType": "off"
},
"correctness": {
"noUnusedVariables": "off",
"noUnusedImports": "off"
}
}
}
}
]
}
</syntaxhighlight>Example ESLint config (<code>.estlintrc.cjs</code>) which supports, react and typescript:

{{Note|text=
You will want to customise this to your projects needs. But this is a good base
}}

<syntaxhighlight lang="js">import js from "@eslint/js";
import prettier from "eslint-plugin-prettier";
import tsParser from "@typescript-eslint/parser";
import eslintJs from "@eslint/js";
import eslintReact from "@eslint-react/eslint-plugin";
import globals from "globals";
import ts from "@typescript-eslint/eslint-plugin";

export default [
{
files: ["**/*.{ts,tsx,mjs,js,jsx}", "astro.config.mjs"],
languageOptions: {
globals: { ...globals.browser },
sourceType: "module",
ecmaVersion: 2022,
parser: tsParser,
parserOptions: {
project: ["./tsconfig.json"],
ecmaVersion: "latest",
sourceType: "module",
ecmaFeatures: {
jsx: true, // Enable JSX syntax support
},
},
},
plugins: {
eslintJs: eslintJs.configs.recommended,
eslintReact: eslintReact.configs.recommended,
prettier: prettier,
"@typescript-eslint": ts,
},
settings: {
"mdx/code-blocks": true,
},
rules: {
"@typescript-eslint/triple-slash-reference": "off",
},
},
{
...js.configs.recommended,
...ts.configs.recommendedTypeChecked,
files: ["**/*.ts", "**/*.tsx"],
rules: {
"@typescript-eslint/strict-boolean-expressions": [
2,
{
allowString: false,
allowNumber: false,
},
],
},
},
];</syntaxhighlight>
Node that you must add the following dependencies:

<pre class="txt">@eslint/js
eslint-plugin-prettier
@typescript-eslint/parser
@eslint-react/eslint-plugin
@typescript-eslint/eslint-plugin
</pre>
For formatters, we recommend prettier with the following config:

<syntaxhighlight lang="json">{
"trailingComma": "all",
"tabWidth": 2,
"semi": true,
"singleQuote": false,
"quoteProps": "as-needed",
"jsxSingleQuote": false,
"bracketSpacing": true,
"bracketSameLine": false,
"arrowParens": "always",
"printWidth": 80,
"useTabs": false
}</syntaxhighlight>
(you will need to add <code>prettier</code> as a dependency).

{{Note|text=
It is also worth noting that people have started to mention moving towards <code>biome</code> instead of <code>prettier</code> (even the devs behind prettier), so you may want to use that instead
}}

You can then add the following to your deno.jsonc:

<syntaxhighlight lang="json">{
"tasks": {
// Biome requires running /bin/sh which means it effectively wants all
// permissions
"biome": "deno run -A npm:@biomejs/biome",

// ...
"lint": "deno task biome lint",
"lint:fix": "deno task biome lint --write",
"format": "deno task biome check --write",
"format:check": "deno task biome check",

// With ESLINT + Prettier
"eslint": "deno run -A npm:eslint",
"prettier": "deno run -A npm:prettier",
"prettier:files": "deno task prettier 'src/**/*.{tsx,ts,md,mdx,json}' '*.{json,js,mjs,md}' '.prettierrc'",

"lint": "deno task eslint src --report-unused-disable-directives --max-warnings 0",
"lint:fix": "deno task lint --fix",
"format": "deno task prettier:files --write",
"format:check": "deno task prettier:files --check"
},
}</syntaxhighlight>

== Specifically ==

These are normally the typical styling recommendations for JavaScript:

<ul>
<li><code>camelCase</code> for variables + functions. Preferably, if you had an acronym in the name, all letters should be the same case e.g. <code>myNPC</code> or <code>npcPair</code></li>
<li><code>PascalCase</code> for classes</li>
<li><code>SCREAMING_CASE</code> for global constants</li>
<li>Use <code>const</code> by default. Use <code>let</code> only if you need to reassign to the variable.
Constants in JavaScript + TypeScript are not actually constant, they just can’t be reassigned.</li>
<li>Reduce use of <code>any</code>. Unfortunately TypeScript can be quite dumb at times so this can be used for type conversion.</li>
<li>Prefer <code>"</code> over <code>'</code> for strings, unless you have <code>"</code> inside the string
This one is more personal so not necessary (consistency though!)</li>
<li>Starting a new scope with <code>{</code> should be on the same line, not on a new line, e.g. in javascript:
<syntaxhighlight lang="js">function something(my_arg) {
...
}

// NOT
function something(my_arg)
{
...
}</syntaxhighlight></li>
<li><code>else</code> and <code>else if</code> statements should be on the same line as the scope (ignore the lecturers’ preferences for this).
<syntaxhighlight lang="js">if (myVar === 'Something') {
...
} else if (myOtherVar !== 'THING') {
...
} else {
...
}

// NOT
if (myVar === 'Something') {
...
}
else if (myOtherVar !== 'THING') {
...
}
else {
...
}</syntaxhighlight></li>
<li>Prefer creating your own interface over using the <code>object</code> keyword</li>
<li>ESLint basically covers all my other issues</li></ul>

== Documentation ==

TypeScript and JavaScript have actually good documentation (probably the only good thing about them), so please use it.

Basically please read through [https://gamedevacademy.org/javascript-docstrings-tutorial/ this].

== Package manager ==
As an asside, as already alluded to, [[Bath Open Source Society|BOSS]] has a standard of using [https://deno.com/ deno] for its package manage and runtime due to its significant focus on security. However, this comes with some learning barriers as it unlike your regular npm, yarn or bun and goes further than pnpm.

Our configuration of deno is as follows, which can be found in the <code>deno.jsonc</code> of any project:<syntaxhighlight lang="json">{
"$schema": "https://raw.githubusercontent.com/denoland/deno/refs/tags/v2.8.0/cli/schemas/config-file.v1.json",

"tasks": {
// ... Any "scripts" from package.json
},

"minimumDependencyAge": "P2D",
"vendor": true,
"lock": { "frozen": true }
}</syntaxhighlight>What this configuration does is as follows:

* When updating, the chosen dependency verion must be older than 2 days to help mitigate from supply chain attacks
* By default, the lock file is frozen, and so when adding or updating packages, you must explicity include <code>--frozen=false</code>
* <code>vendor</code> folder is used as a local cache for remote modules, decreasing overall disk usage.

=== Core differences with npm ===

* Added packages must include a namespace, e.g. anything from <code>npm</code> (basically anything) should be prefixed with <code>npm:</code>. You can also install from the [https://jsr.io/ JSR] by prefixing with <code>jsr:</code>
* Scripts are not found in <code>package.json</code> instead they should be in deno's config: <code>deno.jsonc</code> under <code>tasks</code>
* Running "tasks" should be done through deno's task cmd: <code>deno task ...</code>
* Running package scripts, the full package name must be used e.g. <code>deno run -A npm:@biomejs/biome</code>
* You must permit applications to use features such as environmental variables or reading your directories. If deploying yourself, it will ask for each permission. You can also permit anything by using <code>deno run -A</code>

[[Category:Bath Open Source Society]]
[[Category:Programming language guidelines]]

BOSS/Languages/Rust

Pm2022 — Wed, 26 Aug 2026 07:03:30 GMT

Pm2022 moved page BOSS/Languages/Rust to Rust

New page

The Rust compiler is pretty pedantic by default, however, we have a few recommendations:

* Change the default check command in VSCode (instead of check use <code>clippy</code>).
* 4 spaces for tabs.
* Macros are cool but don’t overuse them.
* Use rustfmt: <code>cargo fmt</code>.

= Recommended tools =
== Bacon ==
Get [https://github.com/Canop/bacon bacon], open it in another terminal window, leave it running while you edit. It will save you recompiling constantly to get the verbose compiler output.

It also has handy features:

* <code>a</code> - to check all.
* <code>c</code> - to clippy all.
* <code>t</code> - to run tests.
* <code>n</code> - to run tests via [https://nexte.st/ <code>cargo-nextest</code>].

You can also make it run pedantic checks with <code>bacon pedantic</code>.

== Audit ==
<code>cargo install cargo-audit</code> (or use [https://github.com/cargo-bins/cargo-binstall <code>cargo-binstall</code>]).

You can then run <code>cargo audit</code> to audit your dependencies for security vulnerabilities.

== Flamegraph ==
<code>cargo install cargo-flamegraph</code> (or use [https://github.com/cargo-bins/cargo-binstall <code>cargo-binstall</code>]).

You can then use <code>CARGO_PROFILE_RELEASE_DEBUG=true cargo flamegraph [-- args-for-your-project]</code> to generate a [https://www.brendangregg.com/flamegraphs.html Flamegraph] for profiling and optimising your project.

== Machete ==
<code>cargo install cargo-machete</code> (or use [https://github.com/cargo-bins/cargo-binstall <code>cargo-binstall</code>]).

You can then use <code>cargo machete</code> to remove unused dependencies.

[[Category:Bath Open Source Society]]
[[Category:Programming language guidelines]]

BOSS/Languages/Python

Pm2022 — Wed, 26 Aug 2026 07:03:23 GMT

Pm2022 moved page BOSS/Languages/Python to Python

New page

Should follow [https://peps.python.org/pep-0008/ PEP-8]

== Quick overview ==

<ul>
<li>4 spaces as tabs</li>
<li><code>snake_case</code> for variables, functions and modules</li>
<li><code>PascalCase</code> for classes</li>
<li>Global variables should not be used.</li>
<li>Global constants should be in <code>SCREAMING_CASE</code> when used.</li>
<li>Lines should not be longer than 80 characters</li>
<li>Use trailing commas when the closing bracket is on a new line</li>
<li>Space after comments e.g. <code># something</code></li>
<li>Protected methods and attributes to start with <code>_</code>, private to start with <code>__</code></li>
<li>When a variable is not used, give it the name <code>_</code> e.g.
<syntaxhighlight lang="python">for _ in range(10):
print("Hi")

(important_var, _) = some_func()</syntaxhighlight></li></ul>

== Non-biased opinions ==

<ul>
<li>Try to prioritise readability of code</li>
<li>Order imports alphabetically but split internal imports</li>
<li>Comments should only be written when necessary, mainly to describe why something is done the way it is or to example a really unreadable bit of code (however this normally means you should change the code).</li>
<li>Methods should be ordered alphabetically (with private methods ordered separately and at the bottom of the file) e.g.
<syntaxhighlight lang="python">def a_func():
...

def b_func():
...

def z_func():
...

def _a_private_func():
...

def _b_private_func():
...</syntaxhighlight></li>
<li>Please use statically-typed code when possible: always for functions and parameters and then only for variables when its hard to tell e.g.
<syntaxhighlight lang="python">MY_CONST: dict[str, set[list[(str|int)]]] = {
"something": set(["hi"], [2], [3]),
}

def my_func(param1: int, param2: list[str]) -> (dict[str, int]|None):
my_variable = "hi"
...

def void_func():
...</syntaxhighlight>
However note that we should try to avoid using the <code>str|int</code> type and keep to one type when possible.</li>
<li>Generators are cool but don’t over use them and format them to be more readable with good naming schemes. e.g.
<syntaxhighlight lang="py">cube = np.from_iter((
(y + x for x in range(10))
for y in range(10)
), ...)</syntaxhighlight></li></ul>

== Using Pylint ==

On most IDEs (including vscode) you should be able to get a pylint extension to point out mistakes and annoy you into writing okay code. Please use this as it should help you with the above styling requirements.

You can also use flake8 (however these are really strict and I don’t like some of them), so here is an example configuration (in the <code>.flake8</code> file):

<pre class="toml">[flake8]
extend-ignore = E272,E221,E227,E201,E202
exclude = .git,__pycache__
max-complexity = 10</pre>
== Documentation ==

There is annoyingly no exact style in python for these… Here is something I kinda like.

Documentation should be for all public modules, methods, classes and functions (however please also try to do them for private versions, but they don’t have to be as indepth).

The style of documentation is kinda whatever you want it to be, so here is a somewhat okay layout. (Any better styles are most welcome as long as we are consistent)

Example:

example_module.py

<syntaxhighlight lang="python">"""
Description
"""

def my_func(param1: int) -> str:
"""Description of return which fits in less than 80 chars"""
...

def my_complex_func(param1: list[str]):
"""
Description

Parameters
----------
param1 (type): Description

Return
------
brief_name (type): Description
"""

class MyClass:
"""
Description

Attributes
----------
...
"""

def my_method():
"""..."""
...
</syntaxhighlight>

[[Category:Bath Open Source Society]]
[[Category:Programming language guidelines]]

BOSS/Languages/TypeScript

Pm2022 — Wed, 26 Aug 2026 07:00:06 GMT

cat

← Older revision		Revision as of 07:00, 26 August 2026
Line 280:		Line 280:
	* Running package scripts, the full package name must be used e.g. <code>deno run -A npm:@biomejs/biome</code>		* Running package scripts, the full package name must be used e.g. <code>deno run -A npm:@biomejs/biome</code>
	* You must permit applications to use features such as environmental variables or reading your directories. If deploying yourself, it will ask for each permission. You can also permit anything by using <code>deno run -A</code>		* You must permit applications to use features such as environmental variables or reading your directories. If deploying yourself, it will ask for each permission. You can also permit anything by using <code>deno run -A</code>

			[[Category:Bath Open Source Society]]
			[[Category:Programming language guidelines]]

BOSS/Languages/Rust

Pm2022 — Wed, 26 Aug 2026 07:00:03 GMT

cat

← Older revision		Revision as of 07:00, 26 August 2026
Line 33:		Line 33:

	You can then use <code>cargo machete</code> to remove unused dependencies.		You can then use <code>cargo machete</code> to remove unused dependencies.

			[[Category:Bath Open Source Society]]
			[[Category:Programming language guidelines]]

BOSS/Languages/Python

Pm2022 — Wed, 26 Aug 2026 06:59:58 GMT

cat

← Older revision		Revision as of 06:59, 26 August 2026
Line 114:		Line 114:
	...		...
	</syntaxhighlight>		</syntaxhighlight>

			[[Category:Bath Open Source Society]]
			[[Category:Programming language guidelines]]

BOSS/Languages/Markdown

Pm2022 — Wed, 26 Aug 2026 06:56:25 GMT

Pm2022 moved page BOSS/Languages/Markdown to Markdown

← Older revision		Revision as of 06:56, 26 August 2026
(One intermediate revision by the same user not shown)
Line 24:		Line 24:

	Formatters do exist (e.g. [https://prettier.io/ prettier] or [https://biomejs.dev/ biome]) so use them please!		Formatters do exist (e.g. [https://prettier.io/ prettier] or [https://biomejs.dev/ biome]) so use them please!
			[[Category:Bath Open Source Society]]
			[[Category:Programming language guidelines]]

Category:Disability action group

Pm2022 — Wed, 26 Aug 2026 06:49:06 GMT

Created blank page

New page

Category:Academic representation

Pm2022 — Wed, 26 Aug 2026 06:48:52 GMT

Created blank page

New page

Advertising events

Pm2022 — Wed, 26 Aug 2026 06:46:44 GMT

Debugging:

← Older revision		Revision as of 06:46, 26 August 2026
(One intermediate revision by the same user not shown)
Line 5:		Line 5:
	== Emails ==		== Emails ==

	We need to send emails via both the department and the SU, ~~such~~ that everyone gets them. A lot of ~~computer science~~ students show up to ~~our~~ events despite not being members, so it’s important to include everyone. However, we don’t want to send the same email to anyone twice. ~~We send~~ emails to all computer science students via the Directors of Studies/Teaching, and then to all remaining members via the SU website.		Most societies need to send emails to their members, but departmental societies have a particularly hard time. They need to send emails via both the department and the SU, so that everyone gets them. A lot of departmental students show up to events despite not being members of the SU society, so it’s important to include everyone. However, you don’t want to send the same email to anyone twice. This method allows sending emails to all computer science students via the Directors of Studies/Teaching, and then to all remaining members via the SU website.

	== Using the templating system ==		=== Using the templating system (optional) ===

			{{Note\|text=This section is designed for use by Bath Computer Science Society, and is not necessary for other societies}}

			To ensure we include the correct sponsors' logos, we use a standard template. Steps to use it are below:

	# Download the templating tool		# Download the templating tool
Line 25:		Line 29:
	The [https://www.thesubath.com/resources/thesu/SU-Committee-member-web-tools-guide/ committee web tools] document has a detailed explanation of how to send an email via the SU website. It also has some basic debugging steps.		The [https://www.thesubath.com/resources/thesu/SU-Committee-member-web-tools-guide/ committee web tools] document has a detailed explanation of how to send an email via the SU website. It also has some basic debugging steps.

	For ~~BCSS~~, the process is slightly more complicated. ~~We don’t want~~ to ~~send~~ emails to any ~~Computer Science~~ students via the SU, as they will receive the email from the Directors of Studies/Teaching. The SU doesn’t have any way to filter these, so it has to be done manually, following these steps:		For departmental societies, the process is slightly more complicated. The idea is to avoid sending emails to any students from the department via the SU, as they will receive the email from the Directors of Studies/Teaching. The SU doesn’t have any way to filter these, so it has to be done manually, following these steps. They explain how to send arbitrary HTML (via the Source button) but you can skip that bit and just write a normal email if using HTML is too complicated.

	<ol style="list-style-type: decimal;">		<ol style="list-style-type: decimal;">
Line 80:		Line 84:
	<li>Once the Director of Studies/Teaching have sent it, disable Google Campaign Tracking then click '''Send''' on the SU page.</li></ol></li></ol>		<li>Once the Director of Studies/Teaching have sent it, disable Google Campaign Tracking then click '''Send''' on the SU page.</li></ol></li></ol>

	Debugging:		==== Debugging ====

	# If Java throws an error not related to the tool, debug it using your favourite search engine.		# If Java throws an error not related to the tool, debug it using your favourite search engine.
Line 87:		Line 91:
	=== Via the Director of Studies/Teaching ===		=== Via the Director of Studies/Teaching ===

	Send an email to ~~Zack Lyons~~ or ~~John Benardis, both are happy to send (relevant) emails to~~ the ~~entire~~ department. ~~Zack is often really busy so John~~ has ~~been more responsive lately~~. ~~It is worth noting Fabio sends emails targetted at PG~~-~~T students~~.		Send an email to the relevant Director of Teaching or Director of Studies for the department you are targeting. The university has a [https://www.bath.ac.uk/teams/list-of-directors-of-studies-by-department/ list of Directors of Studies]. The following steps let you send arbitrary HTML, but you can also just write an email if that's too complicated.

	<ol style="list-style-type: decimal;">		<ol style="list-style-type: decimal;">
	<li><p>Ensure the email HTML is in your clipboard by running the [[#using-the-templating-system\|templator]].</p></li>		<li><p>Ensure the email HTML is in your clipboard by running the [[#using-the-templating-system\|templator]].</p></li>
	<li><p>Open [https://outlook.office.com/mail/ Outlook on the Web].</p></li>		<li><p>Open [https://outlook.office.com/mail/ Outlook on the Web].</p></li>
	<li><p>Compose a new email to ~~Zack Lyons. ([mailto:zl221@bath.ac.uk zl221@bath.ac.uk])~~ or ~~John Benardis ([mailto:ib322@bath.ac.uk ib322@bath.ac.uk])~~.</p></li>		<li><p>Compose a new email to the relevant Director of Studies or Director of Teaching.</p></li>
	<li><p>Type an introduction just saying hi and asking them to forward the below email to students (specify whether it is for UG, PG-T or PG-R).</p></li>		<li><p>Type an introduction just saying hi and asking them to forward the below email to students (specify whether it is for UG, PG-T or PG-R).</p></li>
	<li><p>Where you want the email to go, type the word “test”.</p></li>		<li><p>Where you want the email to go, type the word “test”.</p></li>
Line 108:		Line 112:
	== Instagram ==		== Instagram ==

	{{~~Note\|text=This section is a work~~ in progress.}}		{{Work in progress}}

	* Make sure that any Instagram posts have alt-text and a useful caption. Make sure that all information in the photo is duplicated in the caption.		* Make sure that any Instagram posts have alt-text and a useful caption. Make sure that all information in the photo is duplicated in the caption.

	== WhatsApp ==		== WhatsApp ==

Template:Work in progress

Pm2022 — Wed, 26 Aug 2026 06:28:10 GMT

← Older revision		Revision as of 06:28, 26 August 2026
Line 1:		Line 1:
	{{Note\|type=~~reminder~~\|text=This ~~page~~ is a work in progress}}		{{Note\|type=warn\|text='''This article is a work in progress.'''<br>

			It may contain incorrect or incomplete content. Please edit it with improvements and expansions.}}
			<includeonly>[[Category:Help needed]]</includeonly>

Tutorials

Pm2022 — Wed, 26 Aug 2026 06:24:39 GMT

Pm2022 deleted page Tutorials content was: "tes for subpages", and the only contributor was "Hw2210" (talk)

Template:Wip

Pm2022 — Wed, 26 Aug 2026 06:23:16 GMT

Pm2022 moved page Template:Wip to Template:Work in progress

New page

Template:Wip

Pm2022 — Wed, 26 Aug 2026 06:22:27 GMT

Create wip

New page

Main Page

Pm2022 — Wed, 26 Aug 2026 06:16:50 GMT

Ban AI usage

← Older revision		Revision as of 06:16, 26 August 2026
Line 1:		Line 1:
	Welcome to the wiki hosted by students of the University of Bath. It is managed by [[Bath Open Source Society]], and any student is free to login and edit pages. This is designed as a space where societies can store knowledge that can easily be passed down, or even students can share fun facts they have learnt while studying at Bath.		Welcome to the wiki hosted by students of the University of Bath. It is managed by [[Bath Open Source Society]], and any student is free to login and edit pages. This is designed as a space where societies can store knowledge that can easily be passed down, or even students can share fun facts they have learnt while studying at Bath.

	There is minimal restriction to what can be uploaded to this wiki, we just ask that you be polite and follow the [https://www.bath.ac.uk/legal-information/dignity-and-respect-policy/ Dignity and Respect policy]. All edits are associated with your University login and we will follow standard University procedures in the event of serious misconduct.		There is minimal restriction to what can be uploaded to this wiki, we just ask that you be polite and follow the [https://www.bath.ac.uk/legal-information/dignity-and-respect-policy/ Dignity and Respect policy]. All edits are associated with your University login and we will follow standard University procedures in the event of serious misconduct. Please don't upload anything harmful, promotional or AI-generated.

	If you would like help with anything, please contact [mailto:su-boss@bath.ac.uk su-boss@bath.ac.uk].		If you would like help with anything, please contact [mailto:su-boss@bath.ac.uk su-boss@bath.ac.uk].

Disability Access Plan

Pm2022 — Wed, 26 Aug 2026 03:33:05 GMT

clarify wording, add su advice, add find my rep

← Older revision		Revision as of 03:33, 26 August 2026
Line 16:		Line 16:

	=== Non-compliance ===		=== Non-compliance ===
	If your DAP is not being followed, you can either escalate it yourself, via staff, via [[academic representation]], or via a trusted friend. Unfortunately there is currently no way to escalate anonymously, because staff need to know what needs to change. If you would like advice on the potential consequences of escalation, or would like help understanding and explaining your rights, you can contact the [https://www.equalityadvisoryservice.com/ Equality Advisory and Support Service] (this is a free national service and not related to Bath).		If your DAP is not being followed, you can either escalate it yourself, via staff, via [[academic representation]], or via a trusted friend. Unfortunately there is currently no way to escalate anonymously, because staff need to know what needs to change. If you would like advice on the potential consequences of escalation, or would like help understanding and explaining your rights, you can contact the [https://www.equalityadvisoryservice.com/ Equality Advisory and Support Service] (this is a free national service and not related to Bath). The SU Advice and Support service may also be able to advise you

	==== By yourself ====		=== By yourself ====
	Beware that a lot of DAPs (and [[Anticipatory reasonable adjustments\|ARAs]]) have weak wording like “where possible” or “aim to”. Proving non-compliance in these cases is difficult but don’t let that put you off. Sometimes you just need to understand why staff don’t want to make adjustments, but usually with DAP issues you are likely to be in the right. In that case it can be necessary to help the staff understand how to meet your needs collaboratively. However, as a student, the burden is never supposed to fall on you to advocate for yourself. Responsibility for meeting your DAP lies with the University. If you find you are spending considerable amounts of time trying to persuade staff to follow your DAP, please seek support through the other sections.		Beware that a lot of DAPs (and [[Anticipatory reasonable adjustments\|ARAs]]) have weak wording like “where possible” or “aim to”. Proving non-compliance in these cases is difficult but don’t let that put you off. Sometimes you just need to understand why staff don’t want to make adjustments, but usually with DAP issues you are likely to be in the right. In that case it can be necessary to help the staff understand how to meet your needs collaboratively. However, as a student, the burden is never supposed to fall on you to advocate for yourself. Responsibility for meeting your DAP lies with the University. If you find you are spending considerable amounts of time trying to persuade staff to follow your DAP, please seek support through the other sections.

Line 36:		Line 36:

	==== Academic representation ====		==== Academic representation ====
			You can find your academic rep via [https://www.thesubath.com/academicreps/findmyrep/ Find My Rep].

	If you choose to contact your academic rep, you will need to be comfortable sharing the exact wording of your DAP with them. If this is not something you would like to do, it is better to contact a staff member who you trust to advocate on your behalf.		If you choose to contact your academic rep, you will need to be comfortable sharing the exact wording of your DAP with them. If this is not something you would like to do, it is better to contact a staff member who you trust to advocate on your behalf.

Line 43:		Line 45:

	# Student or academic rep contacts unit convener (give them a week to respond)		# Student or academic rep contacts unit convener (give them a week to respond)
	# Students or academic rep contacts Director of Studies (give them 3 days to respond) Please note that the Director of Studies has the authority to give orders to ~~staff members~~, although they may not be aware of this fact.		# Students or academic rep contacts Director of Studies (give them 3 days to respond). Please note that HR have confirmed that the Director of Studies has the authority to give direct orders to lecturers, although they may not be aware of this fact.
	# Student or academic rep contacts department rep		# Student or academic rep contacts department rep
	# Department rep contacts Director of Teaching (give them 3 days to respond)		# Department rep contacts Director of Teaching (give them 3 days to respond)
	# Department rep contacts Disability Service (give them 3 days to respond)		# Department rep contacts Disability Service (give them 3 days to respond)
	# Department rep contacts head of department, and simultaneously, The head of department should usually be able to resolve any issues with ease, as they hold a lot of sway. However, they do not interact much with students, so the issue will need to be explained to them clearly.		# Department rep contacts head of department, and simultaneously, department rep contacts faculty rep. The head of department should usually be able to resolve any issues with ease, as they hold a lot of sway. However, they do not interact much with students, so the issue will need to be explained to them clearly.
	~~# Department rep contacts faculty rep~~		# Faculty rep contacts Associate Dean (Education), and simultaneously, faculty rep contacts Education Officer
	# Faculty rep contacts Associate Dean (Education), and simultaneously
	~~# Faculty~~ rep contacts Education Officer

	These steps are flexible guidance and can be changed depending on the exact issue.		These steps are flexible guidance and can be changed depending on the exact issue.
	[[Category:Disability action group]]		[[Category:Disability action group]]
	[[Category:Academic representation]]		[[Category:Academic representation]]

Terraform

Hw2210 — Tue, 25 Aug 2026 20:41:34 GMT

Module structure: Correct filenames in structure

← Older revision		Revision as of 20:41, 25 August 2026
Line 44:		Line 44:
	The modules are usually structure in the way:		The modules are usually structure in the way:

	* <code>~~init~~.tf</code> – Usually where your <code>providers</code> go and if you are lazy (like me), everything else		* <code>main.tf</code> – Usually where your <code>providers</code> go <s>and if you are lazy (like me), everything else</s>
	* <code>vars.tf</~~code~~>/<code>variables.tf</code> – Where you put all your variables. As explained in [[#Variable madness\|Variable madness]], I really don’t like this ~~and so commonly ignore~~		* <code>variables.tf</code> – Where you put all your variables (even if there are none). As explained in [[#Variable madness\|Variable madness]], I really don’t like this but we have decided to comply with terraform😞.
	* <code>outputs.tf</code> – All your outputs go here		* <code>outputs.tf</code> – All your outputs go here (even if there are none)
	* <code>*.tf</code> – Anything else, if you want to split it out nicely into other files		* <code>*.tf</code> – Anything else, if you want to split it out nicely into other files