Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 08bef05

Browse files
author
Ana Krelling
committedJun 5, 2024
docs: fix typos on first-time-contributors
1 parent 1a4e678 commit 08bef05

File tree

1 file changed

+7
-7
lines changed
  • pages/blog/first-time-contributors

1 file changed

+7
-7
lines changed
 

‎pages/blog/first-time-contributors/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -161,10 +161,10 @@ It's worth noting that some organizations, such as the Open Source Initiative (O
161161
$ git config --global pull.rebase true
162162
```
163163

164-
OSL recommend the usage of git rebase
164+
OSL recommends the usage of git rebase
165165

166166

167-
## Mergin a Pull Requests (PRs)
167+
## Merging a Pull Request (PR)
168168
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:
169169

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

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

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

291291
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.
@@ -294,7 +294,7 @@ While both workflows have their merits, it's essential to assess your team's wor
294294

295295
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).
296296

297-
OSL recommend the github flow
297+
OSL recommends the github flow
298298

299299
## Python Linters Overview
300300

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

390390
- **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.
391391

392-
- **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.
392+
- **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.
393393

394394
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.
395395

396-
# What is a virtual enviroments and why it is important?
396+
# What is a virtual enviroment and why is it important?
397397

398398
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.
399399

400-
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.
400+
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.
401401

402402
Creating virtual environments is crucial for several reasons:
403403

0 commit comments

Comments
 (0)
Please sign in to comment.