From f84b6327999a35b6589a647c286b6344dacfca67 Mon Sep 17 00:00:00 2001 From: scodeadmin <91721634+scodeadmin@users.noreply.github.com> Date: Fri, 1 Oct 2021 00:25:33 -0700 Subject: [PATCH 1/4] Initial commit --- README.md | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..5734a36 --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +# scode +SpeakCode - A collection of code samples to be created and shared by the community From 4f00f6167cf68fc250be200fe98488b784c81a11 Mon Sep 17 00:00:00 2001 From: scodeadmin <91721634+scodeadmin@users.noreply.github.com> Date: Fri, 1 Oct 2021 00:26:20 -0700 Subject: [PATCH 2/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5734a36..6978862 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,2 @@ # scode -SpeakCode - A collection of code samples to be created and shared by the community +SpeakCode - A collection of code samples created and shared by the community From 99538b08494302e6b632745c40a1e2cc116fb6ee Mon Sep 17 00:00:00 2001 From: cawrites Date: Fri, 1 Oct 2021 09:20:03 +0000 Subject: [PATCH 3/4] content update and add --- README.md | 40 +++++++++++++++++++++++++++++++++++++++- shopping-list | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 86 insertions(+), 1 deletion(-) create mode 100644 shopping-list diff --git a/README.md b/README.md index 6978862..f314ff2 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,40 @@ -# scode +## **Speak Code** SpeakCode - A collection of code samples created and shared by the community + +## **Do you speak code?** + +Developers reuse code as part of maintenance, new development, or upgrades. Automation can be a framework designed to deploy new releases; with minor edits to existing code. SRE (Software Reliability Engineers) use code to monitor web, application, and database activities. + +Using an existing library of code, developers can develop new functions or features within the application. These changes are made for accessibility or a change in standards or needs of the business. + +### **Usecases for recycling or reusing Code** + +**Microservices** (A distinctive method of developing software systems that focus on building single-function modules with well-defined interfaces and operations.). **Web APIs** (an application programming interface for either a web server or a web browser) and other web-related components often reuse code. + + **Object-oriented programming (OOP)** organizes software design around data, or objects, rather than functions and logic + +**Modular programming** is a design technique that emphasizes separating the functionality of a program into independent, interchangeable modules, such that each contains everything necessary to execute only one aspect of the desired functionality. + +### **Tips for building a code library** + +* Choose a consistent method for storing and editing modified code. Github is an excellent example of retaining code ownership, history, and change. + +* If using a template, maintain the framework and save copies separately for changes. + +* Research templates and APIs for usability and accessibility. + +* Well-documented code and use case. + +### **Challenges?** + +* Limited knowledge or access to useable code. +* New role or job with limited experience +* Code base changes and a new language is used. + +Developers can literally spend hours look through blogs, forums, and support for useable code. + +### **We need your help** + +**Speak Code** is a way to share your learnings with the community. We are collecting code from the global developer community to share with the world. We are community driven and just getting started so we appreciate your support. + +Check out our shopping list to see what we are looking for. \ No newline at end of file diff --git a/shopping-list b/shopping-list new file mode 100644 index 0000000..5e2db50 --- /dev/null +++ b/shopping-list @@ -0,0 +1,47 @@ +## Code Shopping List + +# We are looking for code samples in: + +Initially we are collecting pull requests in following areas: + +Newer Languages: +* Elixir +* Go +* Dart +* Julia +* Pony +* TypeScript +* Kotlin +* Nim +* Python 3 +* PureScript +* Reason +* Rust +* Swift + +We are also interested in + +* Python +* C +* Java +* C++ +* R +* JavaScript +* PHP +* SQL + +## The pull request + +The pull request should have the following information + +* Codebase - what language is used +* Description of what the code does +* Link to code setup to run from laptop. (ie.https://www.python.org/) +* Tested and functioning code. Working code please. +* Sample data, or results. + +We are working on a template, but for now make sure your PR covers all the points mentioned. + +Please contact the maintainer if you have any questions. + + From 17716f73ab98a864623e9f3285bdacaf5e94f698 Mon Sep 17 00:00:00 2001 From: cawrites Date: Fri, 1 Oct 2021 09:33:46 +0000 Subject: [PATCH 4/4] getting started content --- .github/Getting Started with Github.md | 70 ++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 .github/Getting Started with Github.md diff --git a/.github/Getting Started with Github.md b/.github/Getting Started with Github.md new file mode 100644 index 0000000..e0e94a5 --- /dev/null +++ b/.github/Getting Started with Github.md @@ -0,0 +1,70 @@ +# Getting Started with Github + +## Setting up your environment + +Setting up your environment is essential to becoming a contributor using Github. Once your environment is set, you can monitor your activity through the [website](https://github.com/) or [mobile app](https://github.com/mobile). To contribute to this website, you need to set up your own GitHub account. + +## Create a GitHub account and set up your profile + +Need a GitHub account? [Create one](https://github.com/join). Here's an opportunity to get creative with a username that describes your best qualities. You can use an existing GitHub account to contribute to the website repo or any other repo you are currently using. Don't forget to complete the profile associated with your account. The profile is a way of communicating your interest and what you like to do technically. + +>[!NOTE] +> Profiles are public. Please do not put any personal information in your profile. The entire GitHub community can view what you have written. + +## Setting up the GitHub Stack + +The recommendations provided are based on the setup used by professionals contributors. + +### Install Git + +[Git](https://git-scm.com/downloads) (also known as Git Bash) A command-line-based tool that allows you to submit pull requests, manipulate the branches you created and update your local(forked) copy of the repo. The documentation for [how to use Git](https://git-scm.com/doc) is available online. This tool is available on Linux. + +Free CodeCamp recommends this [list](https://www.freecodecamp.org/news/10-important-git-commands-that-every-developer-should-know/) of Git commands developers should know. + +### Visual Code + +[Visual code](https://code.visualstudio.com/) is available in Windows, Mac, and Linux. It is a lean editing tool that has multiple uses for development. The installation is simple and documented on the site. There is an extensive marketplace for extensions to enhance your experience using this tool built right into the application! Extensions allow you to work more closely with Github and publish branches without leaving the Visual code. + +[Walkthrough using Visual Code for your first Pull Request](https://code.visualstudio.com/docs/editor/github). +It is crucial to **get a local copy of the repo before you start working on the site's content.** + +>[!NOTE] +>New branches and pull requests should only be created in your copy of the repo. You will not be making commits directly to **main**. However, you should pull **main** into your local repo to ensure you are working with the latest published content. It will reduce the risk of conflicts and unintentionally overwriting published content once your pull request merges. + +In the documentation, user groups, and support channels, you'll see the terms like **master** and **origin**. Our content will reference the actual names within the repo whenever possible. + +### Refresh your local repo often + +It is essential to regularly update your local copy of the repo to ensure you have the latest changes. All of the updates approved by the reviewer and merged into the repo will be part of this update. A good routine is to update your local repo before you create or update any open pull requests. + +For example, use Git Bash to update your local repo. Change the current working directory to your local project. + +```bash +/c/github/bc/website (main) + +$ git checkout main +$ git pull upstream main +``` + +Completing this step before you edit or create content will reduce the possibility of a [merge conflict](https://docs.github.com/en/github/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts#resolving-merge-conflicts). + +### Github Desktop + +If you are new to Github or would like a quick visual of what's going on in the repo, this is the tool for you. At a glance, you can see the history of changes in the repo you are working in, your latest changes as well as branches you've created. You can use the Github desktop application to get a copy of any repo you are working in. The GitHub website can connect directly to your desktop. The tool also can publish your branch instantly to the repo. + +Want to leverage Github Desktop? See [Contributing and collaborating using GitHub Desktop](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop) + +### Gitpod + +Interesting in trying the online experience? Try https://www.gitpod.io/docs/quickstart + +### Tips + + The information will be helpful as you being a journey with Github or to refresh your skills. This list is subject to change based on availability. If one of the links no longer works, please advise us, or share a link you've found useful. + +- [GitHub Docs](https://docs.github.com/en) +- [Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) +- [Basic syntax of markdown](https://www.markdownguide.org/basic-syntax/) +- [GitHub markdown syntax PDF](https://guides.github.com/pdfs/markdown-cheatsheet-online.pdf) +- [Create an issue or Pull Request](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request) +