Skip to content

beginner-friendly term explanations #138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −1
Open

beginner-friendly term explanations #138

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion contribute-open-source/get-to-know-repo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,11 @@ Above is a screenshot of the pyOpenSci practice repo that you will use. Notice t
Some repositories have specific **code and text format and workflow requirements**. Make sure to check if the project uses:

- **Code formatters and linters**: Does the project use [code formatters or linters](https://www.pyopensci.org/python-package-guide/package-structure-code/code-style-linting-format.html#python-package-code-style-format-and-linters)?
- **Continuous Integration (CI)**: Are there automated tests and checks that run when a new PR is submitted?

A code formatter automatically tidies how your code looks, while a linter scans it to warn you about possible mistakes—all before you run it.
- **Continuous Integration (CI)**: Are there automated tests and checks that run when a new Pull Request (PR) is submitted?

Continuous Integration is a service that automatically builds and tests your code every time someone pushes or opens a pull request, catching problems early.
- **Licensing**: The [project’s license](https://www.pyopensci.org/python-package-guide/documentation/repository-files/license-files.html) dictates how you can use, modify, and distribute the code.
- The **MIT and BSD-3 licenses** permit broad use with attribution; these licenses are common in the scientific open source ecosystem.
- A **GPL license** requires derivative works to follow the same open source terms. This is what's known as a [copy-left license](https://www.pyopensci.org/python-package-guide/documentation/repository-files/license-files.html#use-open-permissive-licenses-when-possible).
Expand Down