0) Onboarding#

Welcome to the QUEENS project! 👑

We are happy to have you here and created this onboarding guide to help you get started with the project, especially if you are new to open-source development.

Steps to get started with QUEENS#

Clone the QUEENS repository to your local machine via SSH:
```
git clone git@github.com:queens-py/queens.git
```
Read through our introduction and follow the instructions in the “Installation” section to set up your local environment.
If you plan to contribute to the project, please read through our contributing guidelines and follow the instructions there to configure our git-hooks.
Install an integrated development environment (IDE) of your choice if you do not already have one. We recommend using PyCharm or VS Code with some additional extensions.

Optional: For VS Code, we further recommend adding the following settings to your ~/.config/Code/User/settings.json after finding out the path to your QUEENS environment via conda info --envs:
```
"python.pythonPath": "<path_to_your_QUEENS_environment>/bin/python",
"python.defaultInterpreterPath": "<path_to_your_QUEENS_environment>/bin/python",
"editor.formatOnSave": True,
"python.formatting.provider": "black",
"python.formatting.blackPath": "<path_to_your_QUEENS_environment>/bin/black",
```
Browse through our documentation and our other tutorials to get a first impression.
Optional: If you are comfortable with it, feel free to introduce yourself in our discussions forum. For example, you could share your name, prior experience with coding, and a high level description of what you will be working on.
Last but not least, we ask you to follow our code of conduct so we can all thrive in the Qommunity 💂‍♀️👑💂‍♂️

Note

If you find that any of the information in this onboarding guide is outdated or incorrect, please let us know by creating an issue or a pull request on GitHub.

Additional information for rookies#

Git#

We use Git for tracking changes in our files. This way, we can work simultaneously on different parts of the code without disturbing others. For a general introduction to Git, you can check out this article or this video. However, the simplest way to learn Git is by using it.

Python#

If you have made it this far, you will probably end up coding in Python. For an introduction to Python, you can check out this written tutorial or this video.

Linux#

QUEENS is currently developed on Linux so we advise you to do the same. Do not worry if you are not familiar with Linux. There is no big difference from Mac or Windows besides the extended use of the terminal, also known as the command line. At first, this might seem cumbersome, but once you master a basic set of commands, it becomes super efficient! Check out this article to start learning some basic Linux commands. Bonus: If you really want to become a nerd, also have a look at the VIM editor.