Skip to content

Commit

Permalink
docs: fix typos on first-time-contributors
Browse files Browse the repository at this point in the history
  • Loading branch information
Ana Krelling committed Jun 5, 2024
1 parent 1a4e678 commit 08bef05
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions pages/blog/first-time-contributors/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,10 +161,10 @@ It's worth noting that some organizations, such as the Open Source Initiative (O
$ git config --global pull.rebase true
```

OSL recommend the usage of git rebase
OSL recommends the usage of git rebase


## Mergin a Pull Requests (PRs)
## Merging a Pull Request (PR)
Pull requests (PRs) are essential for collaborative software development, enabling contributors to propose changes to a project's codebase. Once a PR is submitted, it undergoes a review process before being merged into the main codebase. Here are three common methods for merging PRs:

#### 1. Merge Commit:
Expand Down Expand Up @@ -285,7 +285,7 @@ GitFlow, developed by Vincent Driessen, provides a more organized approach to br

Choosing between GitHub Flow and GitFlow depends on your team's specific needs and project requirements:

- **GitHub Flow**: Ideal for teams focused on continuous delivery, rapid iteration, and simplicity. This is most used in a bunch of proyects.
- **GitHub Flow**: Ideal for teams focused on continuous delivery, rapid iteration, and simplicity. This is most used in a bunch of projects.
- **GitFlow**: Suited for larger projects with longer release cycles, strict versioning, and a more structured approach to development.

While both workflows have their merits, it's essential to assess your team's workflow preferences, project size, and release cycle frequency before making a decision.
Expand All @@ -294,7 +294,7 @@ While both workflows have their merits, it's essential to assess your team's wor

For a deeper dive into GitFlow's advantages and implementation details, consider referring to the following blog post: [click here](https://lucamezzalira.medium.com/git-flow-vs-github-flow-76b93f4782f7).

OSL recommend the github flow
OSL recommends the github flow

## Python Linters Overview

Expand Down Expand Up @@ -389,15 +389,15 @@ When starting a new Python project, it's beneficial to use project templates tha

- **Cookiecutter**: Cookiecutter is a command-line utility that generates projects from project templates. It prompts you for project-specific details and then creates a customized project structure based on the selected template. There are many community-contributed templates available for various types of Python projects, including web applications, libraries, and data analysis projects.

- **SciCookie**: SciCookie is a project template ocused on the scientific python community, but it can be used by any python project. It includes a structured directory layout, documentation templates, and example code snippets. SciCookie helps streamline the setup process for scientific Python projects and encourages best practices in testing and documentation.
- **SciCookie**: SciCookie is a project template focused on the scientific python community, but it can be used by any python project. It includes a structured directory layout, documentation templates, and example code snippets. SciCookie helps streamline the setup process for scientific Python projects and encourages best practices in testing and documentation.

In summary, while `unittest` provides a robust framework for writing unit tests in Python, alternative frameworks like Pytest and Hypothesis offer additional features and flexibility. When starting a new project, leveraging project templates such as `scicookie` with tools like `cookiecutter` can accelerate setup and promote best practices in project organization and testing.

# What is a virtual enviroments and why it is important?
# What is a virtual enviroment and why is it important?

A virtual environment is a self-contained directory that isolates the dependencies for a specific project, regardless of the programming language. It can house an interpreter (like Python) along with its associated libraries, but it can also manage dependencies for other languages and tools. This isolation ensures that the project's requirements don't conflict with those of other projects on the same system.

When you create a virtual environment for each of your project, it essentially creates a sandboxed environment where you can install packages and dependencies without affecting the global Python installation on your system. This isolation is crucial because different projects often require different versions of libraries or dependencies, and conflicts can arise if they share the same environment.
When you create a virtual environment for each of your projects, it essentially creates a sandboxed environment where you can install packages and dependencies without affecting the global Python installation on your system. This isolation is crucial because different projects often require different versions of libraries or dependencies, and conflicts can arise if they share the same environment.

Creating virtual environments is crucial for several reasons:

Expand Down

0 comments on commit 08bef05

Please sign in to comment.