Hw2210: /* See also */ Don't show redirects

2026-06-05T13:56:16Z

Hw2210: Add a see also section

2026-06-03T20:37:33Z

Add a see also section

← Older revision		Revision as of 20:37, 3 June 2026
Line 78:		Line 78:

	This is better explained [[Git/GitLab#MR Templates\|here]].		This is better explained [[Git/GitLab#MR Templates\|here]].

			== See also ==

			{{Special:PrefixIndex\|prefix=Git\|namespace=0}}
			[[Category:Tutorial]]

Hw2210: Translate from boss.bathcs.com

2026-06-03T17:15:37Z

Translate from boss.bathcs.com

New page

In git there are some files which have some importance, either on your remote repository or just in general.

== README ==

File location: <code>README.md</code>.

When creating a repository on GitHub or GitLab, it will ask if you want to initialise it with a README. This is a file written in [https://confluence.atlassian.com/bitbucketserver/markdown-syntax-guide-776639995.html markdown], which just contains a description of what the project is.

If you visit a project e.g. [https://gitlab.bath.ac.uk/cs/services/froom froom], you will see a description rendered below all the files. This is the README, which both GitLab and GitHub will render on the home directory of your project.

== LICENSE ==

File location: <code>LICENSE</code> or <code>LICENSE.txt</code>.

This stores how a project can be used and altered, if none is given it can be assumed that all rights are reserved. There are strict laws protecting these statuses and so when copying code from open sources projects, please make sure you understand how you can use that code and what the license permits

For [[BOSS]] projects, we have our own [https://boss.bathcs.com/policies/licenses/ License policy] which states all our projects should use the [https://spdx.org/licenses/LLVM-exception.html <code>Apache-2.0 WITH LLVM-exception</code>] license If you are contributing to BOSS, please read the [https://boss.bathcs.com/policies/licenses/|license policy] for the full list of requirements.

== Gitignore ==

File location: <code>.gitignore</code>

This file stores a list of files or folders which should never be included in your git commits.

These will usually include caching files or output directories which should be generated by the developer on their local machine.

An example for a project using <code>deno</code>, <code>yarn</code> and <code>npm</code> is:

<pre># build output
dist/

node_modules
.yarn
!.yarn/releases
!.yarn/plugins
.pnp.*

.vscode
!.vscode/extensions.json
!.vscode/launch.json

# logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*

# environment variables
.env
.env.production

# macOS-specific files
.DS_Store
</pre>

But these will vary depending on the tools and language you are using in a given project.

[https://github.com/github/gitignore Templates] are available online or you can use [https://gitignore.io generate a gitignore] specific to your development setup.

== Gitmodules ==

File location <code>.gitmodules</code>

In most cases, this is not required and so will not be in a repository, this is a special file which is normally autogenerated by the [[Git/Advanced#Submodules|<code>submodule</code> command]] in git (and so probably shouldn’t be edited manually).

But this stores all the locations and repos of the submodules you have added.

== GitLab CI ==

File location <code>.gitlab-ci.yml</code>

This file controls the pipelines on the project, [[Git/GitLab#CI Pipelines|see here for more information]].

== MR/Issue Templates ==

File location <code>.gitlab/merge_request_templates/*.md</code> and <code>.gitlab/issue_templates/*.md</code>.

This is better explained [[Git/GitLab#MR Templates|here]].

← Older revision		Revision as of 13:56, 5 June 2026
Line 81:		Line 81:
	== See also ==		== See also ==

	{{Special:PrefixIndex\|prefix=Git\|namespace=0}}		{{Special:PrefixIndex\|prefix=Git\|namespace=0\|hideredirects=1}}
	[[Category:Tutorial]]		[[Category:Tutorial]]

Git/Special files - Revision history

Hw2210: /* See also */ Don't show redirects

Hw2210: Add a see also section

Hw2210: Translate from boss.bathcs.com