Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
YeisonCardona committed Feb 21, 2024
1 parent 6eadb28 commit c43ac34
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/source/notebooks/01-github.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
" - **Case Sensitivity**: Always use lowercase for `<module_name>`. This ensures uniformity and avoids confusion caused by case-sensitive URLs.\n",
" - **Descriptiveness**: The module name should be highly descriptive. It should clearly reflect the module's purpose or functionality. Avoid using abbreviations unless they are widely understood in the domain.\n",
" \n",
"![border-image](_images/github_create_01.jpeg)"
"![border-image git01](_images/github_create_01.jpeg)"
]
},
{
Expand All @@ -32,7 +32,7 @@
" - **Public Access**: The repository must be set as public. This promotes transparency, fosters collaboration, and encourages community engagement.\n",
" - **Benefits of Public Repositories**: Public repositories can be freely accessed, forked, and contributed to by anyone. They facilitate open-source collaboration and knowledge sharing.\n",
"\n",
"![border-image](_images/github_create_02.jpeg)"
"![border-image git02](_images/github_create_02.jpeg)"
]
},
{
Expand All @@ -44,7 +44,7 @@
" - **No Initial Requirement**: A README file is not initially required in the repository. This is because it will be generated automatically later on.\n",
" - **Automated Generation**: The README will be created automatically to ensure consistency and adherence to project standards. This process will include essential information such as module description, installation instructions, usage examples, and contact information for contributors.\n",
"\n",
"![border-image](_images/github_create_03.jpeg)"
"![border-image git03](_images/github_create_03.jpeg)"
]
},
{
Expand All @@ -57,7 +57,7 @@
" - **Exclusions**: It should exclude common Python temporary files and directories like `__pycache__`, `.pyc` files, virtual environment directories (`venv/`, `env/`), and other non-essential files.\n",
" - **Best Practices**: This practice keeps the repository clean and prevents unnecessary files from being tracked and shared.\n",
" \n",
"![border-image](_images/github_create_04.jpeg)"
"![border-image git04](_images/github_create_04.jpeg)"
]
},
{
Expand All @@ -70,7 +70,7 @@
" - **License Features**: This license allows almost unrestricted freedom in using, modifying, and distributing your software, provided that copyright notices and disclaimers are preserved. It's ideal for open-source projects that aim for broad distribution and utilization.\n",
" - **Implications for Users**: Users and developers can integrate and use your software in almost any project, including proprietary ones, as long as the conditions of the BSD license are met.\n",
"\n",
"![border-image](_images/github_create_05.jpeg)"
"![border-image git05](_images/github_create_05.jpeg)"
]
},
{
Expand All @@ -82,7 +82,7 @@
" - **Simple Process**: To create the repository, simply click on the \"Create repository\" button on GitHub.\n",
" - **User Action**: This action is typically the final step in the repository setup process and is straightforward to execute.\n",
"\n",
"![border-image](_images/github_create_06.jpeg)"
"![border-image git06](_images/github_create_06.jpeg)"
]
},
{
Expand All @@ -94,7 +94,7 @@
" - **Initial State**: Upon creation, the new repository will be empty but configured with the chosen `.gitignore` tailored for Python.\n",
" - **License File**: Additionally, a \"LICENSE\" file based on the BSD 2-Clause \"Simplified\" License will be included in the repository. This file is crucial for legally defining the terms under which your software can be used.\n",
"\n",
"![border-image](_images/github_create_07.png)"
"![border-image git07](_images/github_create_07.png)"
]
}
],
Expand Down

0 comments on commit c43ac34

Please sign in to comment.