From 63fb2bef13d78de8e4659a5346e7590302f633fe Mon Sep 17 00:00:00 2001 From: Ivy DeWitt Date: Tue, 28 Mar 2023 21:03:08 -0400 Subject: [PATCH 1/6] feat: Adding tips on Open Source and creating aliases in zsh/bash --- tip-from-ivyldewitt.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 tip-from-ivyldewitt.md diff --git a/tip-from-ivyldewitt.md b/tip-from-ivyldewitt.md new file mode 100644 index 0000000..8968e66 --- /dev/null +++ b/tip-from-ivyldewitt.md @@ -0,0 +1,42 @@ +# Tips for Getting Started with Open Source, Courtesy of Google's Bard AI + +Contributing to open source is a great way to learn new skills, give back to the community, and make a difference in the world. Here are a few basics of contributing to open source: + +✨ Find a project you're interested in. +* There are thousands of open source projects out there, so it's important to find one that you're interested in and that you think you can contribute to. If you're not sure where to start, you can browse the Open Source Initiative's directory or search for projects on GitHub. + +✨ Read the project's documentation. +* Once you've found a project you're interested in, take some time to read the project's documentation. This will help you understand the project's goals, how it works, and how you can contribute. +Find a way to contribute. There are many ways to contribute to open source projects. You can write code, fix bugs, improve documentation, or even just test the project. If you're not sure what to do, you can ask the project's maintainers for help. + +✨ Submit your contributions. +* Once you've made a contribution, be sure to submit it to the project so that the maintainers can review it. If your contribution is accepted, it will be merged into the project and everyone will benefit from it! +Contributing to open source is a great way to learn new skills, give back to the community, and make a difference in the world. If you're interested in getting involved, I encourage you to find a project you're interested in and start contributing today! + + +# Setting Up Aliases in Bash or ZSH + +> Note: This is applicable to Unix/Linux users. + +To simply your workflow, you can setup alises for standard command line syntax, i.e. "git commit -m" can be simplified to a singular world. There are a few systems that do this already for you, such as Oh My Zsh with additional extensions, but here's a quick guide to setting up an alias. + +1. Open up your bash_profile or zshrc file. Note: This is a hidden file so you'll likely need to run your open file command for your preferred editor or IDE (`nano/vi/code`/etc.) and then `~./{filename}`. +2. In your file, it's recommended to use a header while doing this, i.e. `# ALIASES` +3. The syntax for creating an alias is `alias {alias}='standard command'`. +4. Once you are done, run `source ~/.bash_profile/zshrc` to update your changes. +5. Congratulations! You can now use your alias when running lines on the command line. + +Example aliases + +``` +alias gad='git add' +alias gcm='git commit -m' +alias python='python3' + +``` + +## Additional Resources +[Creating Aliases](https://code2care.org/howto/create-alias-in-macos) +[Creating Aliases Pt 2](https://wpbeaches.com/make-an-alias-in-bash-or-zsh-shell-in-macos-with-terminal/) + +[Bonus Resource for Windows Users using Doskey](https://winaero.com/how-to-set-aliases-for-the-command-prompt-in-windows/) \ No newline at end of file From 34c815c9d0a1470f15e3abd26f08c702b2f6a2b9 Mon Sep 17 00:00:00 2001 From: Ivy DeWitt Date: Tue, 28 Mar 2023 21:06:23 -0400 Subject: [PATCH 2/6] Formatting updates --- tip-from-ivyldewitt.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/tip-from-ivyldewitt.md b/tip-from-ivyldewitt.md index 8968e66..072ce72 100644 --- a/tip-from-ivyldewitt.md +++ b/tip-from-ivyldewitt.md @@ -26,13 +26,12 @@ To simply your workflow, you can setup alises for standard command line syntax, 4. Once you are done, run `source ~/.bash_profile/zshrc` to update your changes. 5. Congratulations! You can now use your alias when running lines on the command line. -Example aliases +## Example Aliases ``` alias gad='git add' alias gcm='git commit -m' alias python='python3' - ``` ## Additional Resources From 1dc17bdb46d3946b7a7e3a799693cca08f168f18 Mon Sep 17 00:00:00 2001 From: Ivy DeWitt Date: Tue, 28 Mar 2023 21:12:43 -0400 Subject: [PATCH 3/6] Additional links and formatting changes --- tip-from-ivyldewitt.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/tip-from-ivyldewitt.md b/tip-from-ivyldewitt.md index 072ce72..35ad69f 100644 --- a/tip-from-ivyldewitt.md +++ b/tip-from-ivyldewitt.md @@ -13,6 +13,13 @@ Find a way to contribute. There are many ways to contribute to open source proje * Once you've made a contribution, be sure to submit it to the project so that the maintainers can review it. If your contribution is accepted, it will be merged into the project and everyone will benefit from it! Contributing to open source is a great way to learn new skills, give back to the community, and make a difference in the world. If you're interested in getting involved, I encourage you to find a project you're interested in and start contributing today! +## Additional Resources +[The Open Source Guide](https://opensource.guide/how-to-contribute/) + +[The Free Code Camp Beginner's Guide](https://www.freecodecamp.org/news/how-to-contribute-to-open-source-projects-beginners-guide/) + +[A Beginner's Bumpy Ride in Open Source| Free Code Camp](https://www.freecodecamp.org/news/a-beginners-very-bumpy-journey-through-the-world-of-open-source-4d108d540b39/) + # Setting Up Aliases in Bash or ZSH @@ -36,6 +43,15 @@ alias python='python3' ## Additional Resources [Creating Aliases](https://code2care.org/howto/create-alias-in-macos) + [Creating Aliases Pt 2](https://wpbeaches.com/make-an-alias-in-bash-or-zsh-shell-in-macos-with-terminal/) -[Bonus Resource for Windows Users using Doskey](https://winaero.com/how-to-set-aliases-for-the-command-prompt-in-windows/) \ No newline at end of file +[Bonus Resource for Windows Users using Doskey](https://winaero.com/how-to-set-aliases-for-the-command-prompt-in-windows/) + + +# Misc Useful Resources + +[Markdown Guide](https://www.markdownguide.org/basic-syntax/#horizontal-rules) + +[Merging vs Rebasing](https://www.geeksforgeeks.org/git-difference-between-merging-and-rebasing/) + From 0266437f95b593c484670ff02474c605e4cfc19e Mon Sep 17 00:00:00 2001 From: Ivy DeWitt Date: Tue, 28 Mar 2023 21:43:22 -0400 Subject: [PATCH 4/6] Adding new tips for submitting a PR --- tip-from-ivyldewitt.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/tip-from-ivyldewitt.md b/tip-from-ivyldewitt.md index 35ad69f..402c28a 100644 --- a/tip-from-ivyldewitt.md +++ b/tip-from-ivyldewitt.md @@ -20,6 +20,28 @@ Contributing to open source is a great way to learn new skills, give back to the [A Beginner's Bumpy Ride in Open Source| Free Code Camp](https://www.freecodecamp.org/news/a-beginners-very-bumpy-journey-through-the-world-of-open-source-4d108d540b39/) +# Tips for Submitting Your First PR + +Here are some tips for submitting your first pull request: + +✨ Read the project's guidelines for pull requests. +* Every project has its own guidelines for pull requests, so it's important to read them before you submit your first one. This will help you understand what the project maintainers are looking for and how you can format your pull request. + +✨ Test your changes. +* Before you submit your pull request, it's important to test your changes to make sure they work as expected. You can do this by running the project's tests or by running your own tests. + +✨ Write a good description. +* When you submit your pull request, be sure to write a good description of what you changed and why. This will help the project maintainers understand your changes and make it easier for them to review your pull request. + +✨ Be patient. +* It can take some time for your pull request to be reviewed and merged. Don't be discouraged if your pull request isn't merged right away. Just keep contributing and eventually your pull request will be merged. +Contributing to open source is a great way to learn new things and give back to the community. If you're interested in submitting your first pull request, I encourage you to follow these tips and make a contribution today! + +## Additional Resources + +[How to make your first PR | Free Code Camp](https://www.freecodecamp.org/news/how-to-make-your-first-pull-request-on-github-3/) +[Creating a PR](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) + # Setting Up Aliases in Bash or ZSH From 90a01c1c8e72240f384ce0ea5d5294eb8d0e2ac1 Mon Sep 17 00:00:00 2001 From: Ivy DeWitt Date: Tue, 28 Mar 2023 21:50:19 -0400 Subject: [PATCH 5/6] Last round of formating --- tip-from-ivyldewitt.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/tip-from-ivyldewitt.md b/tip-from-ivyldewitt.md index 402c28a..2c08e3f 100644 --- a/tip-from-ivyldewitt.md +++ b/tip-from-ivyldewitt.md @@ -1,4 +1,8 @@ -# Tips for Getting Started with Open Source, Courtesy of Google's Bard AI +# General Tips and Resources + +Sourcing information that I found helpful when I was first starting out with coding, and things I've picked up along the way. + +## Tips for Getting Started with Open Source, Courtesy of Google's Bard AI Contributing to open source is a great way to learn new skills, give back to the community, and make a difference in the world. Here are a few basics of contributing to open source: @@ -13,14 +17,14 @@ Find a way to contribute. There are many ways to contribute to open source proje * Once you've made a contribution, be sure to submit it to the project so that the maintainers can review it. If your contribution is accepted, it will be merged into the project and everyone will benefit from it! Contributing to open source is a great way to learn new skills, give back to the community, and make a difference in the world. If you're interested in getting involved, I encourage you to find a project you're interested in and start contributing today! -## Additional Resources +*Additional Resources* [The Open Source Guide](https://opensource.guide/how-to-contribute/) [The Free Code Camp Beginner's Guide](https://www.freecodecamp.org/news/how-to-contribute-to-open-source-projects-beginners-guide/) [A Beginner's Bumpy Ride in Open Source| Free Code Camp](https://www.freecodecamp.org/news/a-beginners-very-bumpy-journey-through-the-world-of-open-source-4d108d540b39/) -# Tips for Submitting Your First PR +## Tips for Submitting Your First PR Here are some tips for submitting your first pull request: @@ -37,13 +41,13 @@ Here are some tips for submitting your first pull request: * It can take some time for your pull request to be reviewed and merged. Don't be discouraged if your pull request isn't merged right away. Just keep contributing and eventually your pull request will be merged. Contributing to open source is a great way to learn new things and give back to the community. If you're interested in submitting your first pull request, I encourage you to follow these tips and make a contribution today! -## Additional Resources +**Additional Resources** [How to make your first PR | Free Code Camp](https://www.freecodecamp.org/news/how-to-make-your-first-pull-request-on-github-3/) [Creating a PR](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) -# Setting Up Aliases in Bash or ZSH +## Setting Up Aliases in Bash or ZSH > Note: This is applicable to Unix/Linux users. @@ -55,7 +59,7 @@ To simply your workflow, you can setup alises for standard command line syntax, 4. Once you are done, run `source ~/.bash_profile/zshrc` to update your changes. 5. Congratulations! You can now use your alias when running lines on the command line. -## Example Aliases +**Example Aliases** ``` alias gad='git add' @@ -63,7 +67,8 @@ alias gcm='git commit -m' alias python='python3' ``` -## Additional Resources +**Additional Resources** + [Creating Aliases](https://code2care.org/howto/create-alias-in-macos) [Creating Aliases Pt 2](https://wpbeaches.com/make-an-alias-in-bash-or-zsh-shell-in-macos-with-terminal/) @@ -71,7 +76,7 @@ alias python='python3' [Bonus Resource for Windows Users using Doskey](https://winaero.com/how-to-set-aliases-for-the-command-prompt-in-windows/) -# Misc Useful Resources +## Misc Useful Resources [Markdown Guide](https://www.markdownguide.org/basic-syntax/#horizontal-rules) From d1087bcefc32c427f3e0db7935a0c3e46bbb9ad3 Mon Sep 17 00:00:00 2001 From: Ivy DeWitt Date: Thu, 30 Mar 2023 19:29:45 -0400 Subject: [PATCH 6/6] Adding explanation on ZSH --- tip-from-ivyldewitt.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/tip-from-ivyldewitt.md b/tip-from-ivyldewitt.md index 2c08e3f..0768e2d 100644 --- a/tip-from-ivyldewitt.md +++ b/tip-from-ivyldewitt.md @@ -49,6 +49,33 @@ Contributing to open source is a great way to learn new things and give back to ## Setting Up Aliases in Bash or ZSH +### What is ZSH? + +The Z shell (Zsh) is a Unix shell that can be used as an interactive login shell and as a command interpreter for shell scripting. Zsh is an extended Bourne shell with many improvements, including some features of Bash, ksh, and tcsh. It was originally developed by Paul Falstad while he was a student at Princeton University. + +Zsh is a powerful and customizable shell that can be used for a variety of tasks. It offers a number of features that make it well-suited for both interactive use and scripting, including: + +* History expansion: Zsh can automatically complete commands based on your previous history. +* Command line editing: Zsh provides a powerful command line editor that allows you to easily edit and execute commands. +* Tab completion: Zsh can automatically complete words as you type them. +* Function definition: Zsh allows you to define functions that can be used to perform repetitive tasks. +* Aliases: Zsh allows you to create aliases for frequently used commands. +* Programmable completion: Zsh allows you to customize the way that it completes commands. +* Programmable history expansion: Zsh allows you to customize the way that it expands commands from your history. +* Programmable prompt: Zsh allows you to customize the way that it displays the prompt. +* Plugins: Zsh supports a large number of plugins that can add additional features to the shell. + +Zsh is a popular shell among both system administrators and power users. It is the default shell on macOS and is available for most other Unix-like operating systems. + +Here are some of the reasons why you might want to use Zsh: + +* It is a powerful and customizable shell that can be used for a variety of tasks. +* It offers a number of features that make it well-suited for both interactive use and scripting. +* It is the default shell on macOS. +* It is available for most other Unix-like operating systems. +* If you are looking for a powerful and customizable shell, Zsh is a good option to consider. + + > Note: This is applicable to Unix/Linux users. To simply your workflow, you can setup alises for standard command line syntax, i.e. "git commit -m" can be simplified to a singular world. There are a few systems that do this already for you, such as Oh My Zsh with additional extensions, but here's a quick guide to setting up an alias.