Add README file for developers (TulipaEnergy#5)

* Add README file for developers

This file has the developers' guide for contributions to this repository.

* Update README.dev.md

Co-authored-by: nope82 <[email protected]>

* Apply suggestions from code review

Co-authored-by: nope82 <[email protected]>

* Fix markdown lint

---------

Co-authored-by: nope82 <[email protected]>

README.dev.md

@@ -0,0 +1,80 @@
+# Developer documentation
+
+1. Fork this repository.
+2. Clone your fork.
+3. Add this repo as upstream with the following command:
+
+   ```bash
+   git remote add upstream https://github.com/TNO-Tulipa/TulipaBulb.jl
+   ```
+
+4. Open this project in your editor.
+5. On Julia, activate and instantiate the project under the package mode.
+6. Run the tests to make sure that everything is working as expected.
+
+## Linting and formatting
+
+Install a plugin to use [EditorConfig](https://editorconfig.org).
+
+We use [https://pre-commit.com](https://pre-commit.com) to run the linter and formatter of many things.
+In particular, the Julia code is formatted using [JuliaFormatter.jl](https://github.com/domluna/JuliaFormatter.jl).
+
+You can install `pre-commit` globally using `pip install --user pre-commit`.
+If you prefer to create a local environment with it, do the following:
+
+```bash
+python -m venv env
+. env/Scripts/activate
+pip install --upgrade pip setuptools pre-commit
+```
+
+On Unix or MacOS, you need to active the environment using the following command instead of the previous one:
+
+```bash
+. env/bin/activate
+```
+
+With `pre-commit` installed, activate it as a pre-commit hook:
+
+```bash
+pre-commit install
+```
+
+To run the linting and formatting manually, enter the command below:
+
+```bash
+pre-commit run -a
+```
+
+Do it once now to make sure that everything works as expected.
+
+Now, you can only commit if all the pre-commit tests pass.
+
+**Note:** on subsequent occassions when you need to run pre-commit in a new shell, you will need to activate the Python virtual environment. If so, do the following:
+
+```bash
+. env/Scripts/activate
+pre-commit run -a
+```
+
+## Contributing workflow
+
+- Always branch from `main`
+
+- Add a branch prefix
+
+  - If there is an associated issue, add the issue number
+  - If there is no associated issue, **and the changes are small**, add a prefix such as "typo", "hotfix", "small-refactor", according to the type of update.
+  - If the changes are not small and there is no associated issue, then create the issue first, so we can properly discuss the changes
+
+- Commit message
+
+  - Use imperative, present tense (Add feature, Fix bug)
+  - Have informative titles
+  - If necessary, add a body with details
+
+- Try to create "atomic git commits" (recommended reading: [The Utopic Git History](https://blog.esciencecenter.nl/the-utopic-git-history-d44b81c09593))
+- Make sure the tests pass
+- Make sure the pre-commit tests pass
+- Before creating the pull-request, fetch any `main` updates from upstream and rebase your branch into `origin/main` if necessary
+- Open a pull request and work with the reviewer to address any issues