Skip to content
Snippets Groups Projects
CONTRIBUTING.md 3.62 KiB
Newer Older
# Welcome to our contribution guidelines 

thank you for taking the time on contributing on our project. Don't forget to read our [code of conduct](conduct.md) and [license](LICENSE.md), to get to know better our project principles. 

Alejandra Camelo Cruz's avatar
Alejandra Camelo Cruz committed
# Contributor guide
Alejandra Camelo Cruz's avatar
Alejandra Camelo Cruz committed
To make yourself confortable with the functions of our project, you can read the [README.md](README.md) file with all the specifications. Consider that our contribution guideline are based on the [GitHub docs contributing guide](https://github.com/github/docs/blob/main/CONTRIBUTING.md).


# Workflow

## Issues

### Create an issue

If you find any problem in our project you wanna work with, be sure there is no [existent issue](https://gitup.uni-potsdam.de/kar/global_inflation_analyser/-/issues?sort=created_date&state=opened) related to that problem. If there is no [existent issue](https://gitup.uni-potsdam.de/kar/global_inflation_analyser/-/issues?sort=created_date&state=opened), [create an issue](https://gitup.uni-potsdam.de/kar/global_inflation_analyser/-/issues/new) in the repository. 

### Solve an issue

Alejandra Camelo Cruz's avatar
Alejandra Camelo Cruz committed
If there is an [existent issue](https://gitup.uni-potsdam.de/kar/global_inflation_analyser/-/issues?sort=created_date&state=opened), create a branch aiming at solving that issue. After following the workflow and opening a pull request, link the pull request to the issue.
Alejandra Camelo Cruz's avatar
Alejandra Camelo Cruz committed
- **Fork the project.**
- Create a Branch that specifically addresses the issue/problem you want to solve/work with.
Alejandra Camelo Cruz's avatar
Alejandra Camelo Cruz committed
If you find any element in our docs that must be improved such as erratas, style improvements, etc, you can propose an improved version.
Alejandra Camelo Cruz's avatar
Alejandra Camelo Cruz committed
Remember that our code is created following Object Oriented programming. Familiarize yourself with the existing code and propose improvements thinking of the already existing OOP.
Alejandra Camelo Cruz's avatar
Alejandra Camelo Cruz committed
When a change have been made to the code or to the documents, commit your changes with significant messages that allow to understand the change proposed.
Alejandra Camelo Cruz's avatar
Alejandra Camelo Cruz committed
**IMPORTANT: If a change have been made to the code, don't forget to adjust the in-code documentation properly. This is important for a correct global documentation of the project.**

## Keep your branch up to date

Remember to check changes made on the main branch, which might put your working branch ahead. Don't forget to rebase your branch and keep it up to date.
Alejandra Camelo Cruz's avatar
Alejandra Camelo Cruz committed
When a change have been done and commited in a branch and you want to merge it into the main project. Create a pull request. You can read the following documentation on [pull requests from forks](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork). 

Don't forget to link your pull request to the issue you are working on.
Alejandra Camelo Cruz's avatar
Alejandra Camelo Cruz committed
If the pull request meets sucesfully the conditions for the code, it will be merged to the main branch incorporating the feature changes proposed.

If there are comments related the solution you are proposing. We are going to note comments them in the issue in order to solve them. Only until all the 

# Contact information

If you want to contact any of the main collaborators of the project, you can write an email to:

- Kshitij Kar - [kar@uni-potsdam.de](mailto:kar@uni-potsdam.de)
- Alejandra Camelo Cruz - [camelocruz@uni-potsdam.de](mailto:camelocruz@uni-potsdam.de)
- Bruk Asrat Tsega - [tsega@uni-potsdam.de](mailto:tsega@uni-potsdam.de)
- Leon Oparin - [leon.oparin@uni-potsdam.de](mailto:leon.oparin@uni-potsdam.de)

*Institute for Informatics and Computational Science*

*University of Potsdam*