| marp | header | footer | theme | paginate |
|---|---|---|---|---|
true |
Open-Source Project |
Prof. Dr. Gerit Wagner |
ub-theme |
true |
Juniorprofessur für Digital Work
- Prof. Dr. Gerit Wagner
- At Bamberg University since October, 2022
- I work with Git, Python, and R since 2014
- I enjoy coding, solving programming puzzles, and building tools
- My latest and most significant project: CoLRev
- Use git and GitHub for versioning and collaboration
- Git quickly established itself as the most popular version control system
- As a prominent example, Microsoft has acquired GitHub and moved the source code of Windows to git (1)
- Many companies have public GitHub programs and share parts of their work as Open-Source (e.g., Google or Meta)
- Write Python code and contribute to a Python package
- Python is the leading programming language in several rankings, including the TIOBE Index and the PYPL (PopularitY of Programming Language) ranking
- Job requirements for Data Scientists, Full-stack Software Engineers, DevOps Engineers, or Data Engineers commonly include Python (1)
- Work with the Open-Source workflows of GitHub
- Make a first contribution to a public Open-Source project
- Adopt the role of a maintainer and review code of your peers
- Have an opportunity to create your developer portfolio
Collaborative Literature Reviews (CoLRev) is an open-source environment for collaborative literature reviews. It integrates with differerent synthesis tools, takes care of the data, and facilitates Git-based collaboration.
The following features stand out:
- Supports all literature review steps: problem formulation, search, dedupe, (pre)screen, pdf retrieval and preparation, and synthesis
- An open platform based on shared data and process standards
- Builds on git and its transparent collaboration model for the entire literature review process
- Focus: command-line interface
<style> img[alt~="center"] { display: block; margin: 0 auto; } </style>
Dates and rooms are available online. We will evaluate the code four days before the code review session.
You assign yourself to a group when you contribute code following these steps:
- Signal your intent to contribute by joining the issue discussion on Github (in the issue discussion, before the Git Session, for two topics at most).
- Organize your work, meet potential group members, and select a project leader (in the following sessions). Keep in mind that no more than 6 people will be accepted per group.
- Officially sign up for a group by contributing a non-trivial code part. Contributions of team members must be in separate commits. Select a project lead who sends your Github-ID together with a link to your code contribution, your student ID, and e-mail address to gerit.wagner@uni-bamberg.de.
This process ensures that all group members make a fair contribution. It is at our discretion to adapt the rules if necessary. It is your responsibility to bring up concerns early.
- Embrace the challenge and adopt a problem solving mindset
- Take full responsibility to set up your programming environment
- Be prepared. Know your code, be able to explain it, and ask prepared questions (Google it, consider different options)
- Do not use generative AI such as ChatGPT (risk of copyright infringement)
- Adopt an Open-Source approach (work publicly, communicate in English, create a profile)
- Reach out and schedule individual hacking sesisons via calendly to discuss challenges and get feedback
- Organize as a team, following Open-Source principles (e.g., create atomic commits; use branches and pull requests; review, discuss, revise, and test your code)
- Adopt an Open-Source approach (work publicly, communicate in English, create a profile)
- Be able to explain the code contribution of the team as a whole
- Each team member: Make a concise and high-quality contribution to the code. This is a necessary condition to pass the course. We review code contributions at the end.
- Embrace the challenge and adopt a problem solving mindset
- Contribute your code to the CoLRev project and have your code merged
- Attend your presentation session and contribute to the code review
- Do not use generative AI such as ChatGPT (risk of copyright infringement)
Go to the CoLRev project repository.
Form groups of three and try to find the following information in 10 minutes:
- How many commits, contributors, and downloads does the project have? What's the test coverage?
- Where is the documentation and how can I install CoLRev?
- What's the license and where can we find information on how to contribute to the project?
- What information should be provided for bug reports, where can I open a feature request?
- How many issues are open vs. closed? How many pull requests are open vs. closed?
- How long do workflows with tests or code formatting run, when did the last one fail?
- What is "unpaywall" used for in the project?
- Where can we find the features planned for milestone v0.12.0 (due March 1st)?
An overview of the process and the worfklow are available in the documentation. A brief overview is available on YouTube.
Find a topic
- Go to milestone v0.13.0 and read the open issues (available topics).
- Find others who are interested in the same topic.
- Ask questions.
- Sign up for our VC course (password: shaiChi4)
- Create a GitHub account (using your student e-mail address), start exploring issues, and team up
- Set up your programming environment (see instructions in the CoLRev documentation)
