bitprj / bitcamp Goto Github PK
View Code? Open in Web Editor NEWFree, open-source software engineering bootcamps.
Free, open-source software engineering bootcamps.
Slack Bitcamp: Need for Tutorial-Based Issues
The Slack Bitcamp has around 3-4 homework issues for every week. These issues are meant to teach the campers the skills and concepts for the week. However, the first draft for these issues used a research-based strategy, where students would mainly read articles and create projects based off of those readings. We instead need to take a tutorial-based approach to streamline the students' learning to the contents of the issue, guiding them step-by-step through more focused projects.
Homework Issue Documentation
The need for tutorial-based issues.
Each week involves at least one guided project (written in a markdown file) loosely based off of the livestream. The solution for this project can be found under homework solutions
in the respective weekly directories. The issue should lead the students to the solution. These issues can be in conjunction with some light reading to contextualize the concepts for that week.
Refer to the issues for Week 1 of BitCamp Slack as an example.
There are several resources outlining how to write a step by step coding tutorial. This medium article is a great place to start.
None.
Is your proposal related to a problem?
Updating the GameDev curriculum
Describe the solution you'd like
Upload Weeks 4 and 5 of the GameDev Curriculum
Additional context
Weeks 4 and 5 of 7, as part of BitCamp GameDev.
Is your proposal related to a problem?
Serverless README has formatting problems because it is too complicated.
Is your proposal related to a problem?
Currently the JS curriculum is too easy and not fun.
Describe the solution you'd like
Describe alternatives you've considered
Have not considered alternative solutions at the time
Additional context
JS is scheduled to start on Jan 29th, we have 2 weeks to complete this.
Is your proposal related to a problem?
Updating the GameDev curriculum
Describe the solution you'd like
Upload Weeks 6 and 7 of the GameDev Curriculum
Additional context
Weeks 6 and 7 of 7, as part of BitCamp GameDev.
Is your proposal related to a problem?
Documentation on how to contribute.
Describe the solution you'd like
Within the Documentation, you can include how to post a gif.
Is your proposal related to a problem?
Currently, we would have to manually sync the Serverless subdirectory with our Serverless learning lab. to automate that process we need to change the directory structure of our repo.
Describe the solution you'd like
Change the current serverless subdirectory within BitCamp to this format:
week1
homework
Describe alternatives you've considered
None.
Additional context
None.
Currently, there are separate repos for each component of Bitcamps, particularly the Learning Lab. This leads to camp content being unorganized and hard to locate.
To centralize Bitcamp materials in one place, use a variation of this Github action to sync files in the Learning Lab repository to files in a corresponding subdirectory within this BitCamp repository.
Example: Syncing the Serverless Functions learning lab repo with a subdirectory within the Serverless directory in this BitCamp repo named learning-lab/
Currently, the README.md files for each of the weeks, as well as the one for the main repository does not provide enough context. Please add gifs/screenshots of the projects, more detailed descriptions, and links to videos (if exists).
Is your proposal related to a problem?
Currently the main README.md file doesn't have a graphic at the very top that improves the visual aesthetic.
Describe the solution you'd like
Add a relevant graphic at the top of the README.md file similar to the one here: https://github.com/freeCodeCamp/freeCodeCamp
Describe alternatives you've considered
None.
Additional context
None.
Is your proposal related to a problem?
Updating the GameDev curriculum
Describe the solution you'd like
Upload Weeks 1 and 2 of the GameDev Curriculum
Additional context
Weeks 1 and 2 of 7, as part of BitCamp GameDev.
Can a complete beginner who doesn't know anything about html, css, js do this? Are there any steps that should be taken before starting the camp? This is usually a good place to put prerequisites. Instructions for setting up, if any, can be put here or put as an assignment if that's too much for this README.
Is your proposal related to a problem?
Updating the GameDev curriculum
Describe the solution you'd like
Upload Week 3 of the GameDev Curriculum
Additional context
Week 3 of 7, as part of BitCamp GameDev.
Is your proposal related to a problem?
Currently, we would have to manually sync this repo with our learning lab repo. to automate that process we need to change the directory structure of our repo.
Describe the solution you'd like
change the directory structure to
week1
livestream code
livestream blog
readme
week2....
homework
config.yml
issues/...
solutions/...
images/...
Need for "How to Contribute to Issues" Documentation
At the current stage, there is no documentation if an open-source user wants to contribute to the BitCamp (or any repository in general) repo. We need a markdown file explaining the steps of contributing to an open-source repository, specifically, one of ours. In this file, we need steps on finding issues that are open for open-source users (and different fields: newcomers, advanced, etc) and steps on contributing and actually handling the issue (forking the repo, creating a PR and notifying Bit Project members).
Issue Documentation Addition
Need for "How to Contribute" Documentation
A markdown file filled with steps through information and photos that explain, in a simple way, how an open-source user can contribute to a Bit Project repository. In this file, we need steps on finding issues that are open for open-source users (and different fields: newcomers, advanced, etc) and steps on contributing and actually handling the issue (forking the repo, creating a PR and notifying Bit Project members).
None.
There are many examples of other open-source repositories that already have "how to contribute" issues and sites that give good step to step tutorials (https://github.blog/2020-01-22-browse-good-first-issues-to-start-contributing-to-open-source/)
None.
Create documentation to explain
Documentation of NoSQL Bitcamp is not complete.
Add to the documentation of the Week 4 NoSQL Bitcamp here, following the format of Serverless. Refer to curriculum draft as needed. Add to PR as project is finalized, including gifs to demonstrate when appropriate. This documentation should be written in a way that someone unfamiliar with Bitcamps (specifically NoSQL) can contribute.
Week 4: MongoDB - Implementing Database with Atlas Realms
Be as specific as possible in regards to what students will accomplish. Ex: What components of Git Bash will be taught?
The Slack camp week descriptions (1 and 2) contain only "livestream" and "homework." In the root directory and in individual week folders add:
In each individual week folder, add a section that explains how the livestream helps students with homework. This should clarify for contributors how the two portions of the bitcamp work together.
Is your proposal related to a problem?
After livestreams, students don't have a place where they can reference all the code and content that was covered.
Describe the solution you'd like
Providing students with livestream blogs give them a place where they can quickly review the steps taken without needing to skip through the video. Blogs would include code snippets and any other needed instructions.
Describe alternatives you've considered
None.
Additional context
None.
Documentation of NoSQL Bitcamp is not complete.
Add to the documentation of the Week 3 NoSQL Bitcamp here, following the format of Serverless. Refer to curriculum draft as needed. Add to PR as project is finalized, including gifs to demonstrate when appropriate. This documentation should be written in a way that someone unfamiliar with Bitcamps (specifically NoSQL) can contribute.
Week 3: The Web App (JS and HTML/CSS)
Be as specific as possible in regards to what students will accomplish. Ex: What about web applications should be the main takeaway for students? How to connect frontend to backend?
BitCamp/Serverless-Functions/week0/homework/issues/Prerequisite.md
Welcome to Bit Camp, where students get hands-on experience with software engineering. Before the program starts, please find some time to complete the following assignment: learn/review JavaScript fundamentals that will later be used in the program. To complete this assignment, you will be creating a digital clock using JavaScript to demonstrate your skills!
This sounds like two assignments a student has to do when this should only be just about creating the digital clock. If you want to create an assignment just for learning/reviewing Javascript, follow a structure. That could be creating another folder with a README full of tutorial links or a folder full of your own tutorial for learning basic Javascript. If you just want to let them know that they should know basic JS before starting, just say it is a prerequisite, not an assignment
Describe the bug
The readme is missing key elements
Context
main root folder readme.
Desired Outcome
add missing elements
Slack Bitcamp reminder, to finish curriculum with new format for Week 1 through Week 4 @Bahburs.
Is your proposal related to a problem?
Instructors need clear guidelines (training) for their roles.
Describe the solution you'd like
Documentation
Describe alternatives you've considered
(Write your answer here.)
Additional context
(Write your answer here.)
Describe the bug
Slack Content is not finalized and the repository is not finished with any READMEs explaining the overall Bit Camp.
Context
The URL is located in bitprj/BitCamp/Slack-Apps, needs a overall README file (like the sample Bit Camp one) and general explanations for each week.
Desired Outcome
A README file for each week and a README file for the overall folder.
(Optional) Possible Solutions
None.
Additional context
Should be finished by 1/4 by @Bahburs.
There's only a folder for the solution. Is there a code template or anything for a student to get started with? Could steps be provided for setting up and also seeing the end result?
Is your proposal related to a problem?
Currently, we would have to manually sync this repo with our learning lab repo. to automate that process we need to change the directory structure of our repo.
Describe the solution you'd like
change the directory structure to
week1
livestream code
livestream blog
readme
week2....
homework
config.yml
issues/...
solutions/...
images/...
The Slack Bitcamp has around 3-4 homework issues on top of a livestream for every week. These issues are meant to teach the campers the skills and concepts for the week. However, they are meant to build upon the important concepts introduced to campers via the livestream. If a student is not able to make a livestream for whatever reason, or requires additional help, it would be easier for them to refer to a written out tutorial as well as watching the livestream recording. This creates the need for an issue dedicated to outlining the contents of each week's livestream.
Livestream Issue Documentation
The need for Livestream Issues
Each week involves at least one guided project during livestream. The tutorial/guide for this project can be found under livestream in the respective weekly directories. The issue should lead the students to building the projects and understanding the concepts outlined in the livestream.
Refer to the livestream issue for Week 1 of BitCamp Slack as an example.
There are several resources outlining how to write a step by step coding tutorial. This medium article is a great place to start.
None.
#90
Documentation for Repo Structure
Context:
There is currently no documentation for how Bit Project BitCamp subdirectories within this repo are structured.
Type:
BitCamp repo structure Documentation
Actual Issue:
A lack of explanation about camp subdirectories can be problematic for open-source contributors who wish to help improve the documentation of the camps. Knowing the structure and what is expected in each subdirectory is helpful when contributing.
Open-source contributors are able to understand where instructions in issues are referring to and what a "good" documentation of a BitCamp looks like.
None.
None.
Describe the bug
For Bitcamp GameDev, the READMEs and the repo is incorrectly formatted (as well, any README files should be called "README.md"). For documentation of bitcamps, we need to follow a standard guideline so all our repos are easy to access.
Context
Problem is within bitprj/Bitcamp/GameDev.
Desired Outcome
The outcome should be a complete repository with README files following the standard (which can be seen here: https://github.com/bitprj/BitCamp/tree/master/repo_logistics/sample-camp and as an example: https://github.com/bitprj/BitCamp/tree/master/Slack-Apps).
(Optional) Possible Solutions
None.
Additional context
If you need help with formatting it or have any questions (not relating to: https://github.com/bitprj/BitCamp/tree/master/repo_logistics/sample-camp) then reach out to @Bahburs.
Currently, the README.md files for each of the weeks, as well as the one for the main repository does not provide enough context. Please add gifs/screenshots of the projects, more detailed descriptions, and links to videos (if exists).
Describe the bug
The serverless homework issues in this repository are outdated. They are missing the update from the new iteration.
Context
After the Fall 2020 iteration, the 2021 mentors revised the curriculum. The issues for the Learning Lab were edited and new md files were added. They are located here
Desired Outcome
The homework issues should be updated with the new curriculum revisions.
(Optional) Possible Solutions
Refer to the new Learning Lab repository and include the new response files.
Additional context
None.
Follow format for https://github.com/bitprj/BitCamp/tree/master/Serverless-Functions
Documentation for working with learning labs is needed, specifically for the config.yml
files.
Task 2: create and deploy an HTTP trigger Azure Function that outputs the current time and date.
Honestly, I don't anything about Azure. I'm assuming if the student knows about Azure but this is their first time working with Azure, then the student should get a little more than this sentence to get to the solution.
Forget this, didn't realize this is in git learning lab
Currently, the README md file for the entire camp does not contain all information needed for an open-source contributor to understand the purpose of the camp. Finish the md file.
There's no documentation for anyone else to contribute to this.
Are you looking for students to take the course to contribute? There's no mention of contributing in the course.
If contributors are taken to this repo, there's no documentation on the organization and structure. You can link contributors directly to the file they want to contribute to as they take the course, but it looks like there's no way to know what can and needs to be changed without going through the lab to know the flow.
Describe the bug
The main serverless README.md file contains a description: "Serverless architectures offer greater scalability, more flexibility, and quicker time to release, all at a reduced cost. Functions is also a great solution for processing bulk data, integrating systems, working with the internet-of-things (IoT), and building simple APIs and micro-services." that lacks information that would help students and/or open-source contributors.
Context
This is the file that requires improvement.
Desired Outcome
The new and improved description should provide more context as to what the students will be learning and how serverless functions can benefit them.
(Optional) Possible Solutions
An example of a good structure: https://www.codecademy.com/learn/learn-circuitpython
CircuitPython is a programming language designed to simplify experimenting and learning to program on hardware devices. It makes getting started with low-cost microcontroller boards easier than ever before. It adds hardware support for Python, so if you already have Python knowledge, you can easily apply that to using CircuitPython. If you have no previous experience, itβs really simple to get started!?
Additional context
None.
Is your proposal related to a problem?
Yes. Pull Requests are very messy and don't really describe what folks are committing.
Describe the solution you'd like
Add a pull request template.
Additional context
The Javascript camp documentation does not include week descriptions. In the root directory and in individual week folders add:
In each individual week folder README.md files, also add:
Bit Project Issue Template
Previously, there was no issue template for members to use whenever they were creating an issue that needed to be addressed. To organize and better keep our Github repository clean, we need to create a standard form for users to fill out.
Issue Documentation Addition
Need for Issue Template
The issue template should address the problem/issue, give any context or information that would help a user/open-source member contribute and fix it, and also clearly label any examples/hints that would help fix the issue.
None.
Some other users have created some pretty advanced issue templates (see https://github.com/stevemao/github-issue-templates), we could use this for inspiration or as an example.
None.
Currently, the root md file documentation for Bitcamp Slack is detailed but not yet friendly for new open-source contributors unfamiliar with the camp. Split the "Overview:" into sections similar to that of the Serverless Bitcamp. This will clarify to contributors what tools the camp utilizes, what the objectives are, and what students will learn in a more readable format.
The Slack Bitcamp has around 3-4 homework issues on top of a livestream for every week. These issues are meant to teach the campers the skills and concepts for the week. However, they are meant to build upon the important concepts introduced to campers via the livestream. If a student is not able to make a livestream for whatever reason, or requires additional help, it would be easier for them to refer to a written out tutorial as well as watching the livestream recording. This creates the need for an issue dedicated to outlining the contents of each week's livestream.
Livestream Issue Documentation
The need for Livestream Issues
Each week involves at least one guided project during livestream. The tutorial/guide for this project can be found under livestream in the respective weekly directories. The issue should lead the students to building the projects and understanding the concepts outlined in the livestream.
Refer to the livestream issue for Week 1 of BitCamp Slack as an example.
There are several resources outlining how to write a step by step coding tutorial. This medium article is a great place to start.
None.
Documentation of NoSQL Bitcamp is not complete.
Add to the documentation of the Week 2 NoSQL Bitcamp here, following the format of Serverless. Refer to curriculum draft as needed. Add to PR as project is finalized, including gifs to demonstrate when appropriate. This documentation should be written in a way that someone unfamiliar with Bitcamps (specifically NoSQL) can contribute.
Week 2: Azure Functions
Be as specific as possible in regards to what students will accomplish. Ex: What should students understand about Azure Functions after, and what skills will they gain?
The Javascript Bitcamp does not currently have a root md file that gives a general description of the entire camp. Providing one allows contributors to get an idea of how the camp is structured and what the specific goals are of the camp. Create a README.md file for Bitcamp/Javascript that includes content from "Bitcamp Serverless β‘" and stopping at "Week 1" in this file.
Is your proposal related to a problem?
Students new to programming aren't given the resources to contribute to the repo.
Describe the solution you'd like
Add guides that teach the fundamentals of open source.
Documentation of NoSQL Bitcamp is not complete.
Add to the documentation of the Week 1 NoSQL Bitcamp here, following the format of Serverless. Refer to curriculum draft as needed. Add to PR as project is finalized, including gifs to demonstrate when appropriate. This documentation should be written in a way that someone unfamiliar with Bitcamps (specifically NoSQL) can contribute.
Week 1: GitHub/Git Bash and MongoDB (Create and access databases)
Be as specific as possible in regards to what students will accomplish. Ex: What components of Git Bash will be taught?
Is your proposal related to a problem?
During the process of completing a learning lab, it would be nice to have a markdown, blog version of the live stream available for the student to allow them to follow along.
Describe the solution you'd like
Add steps to the learning lab after the live stream feedback that have the markdown blog already written by pullrequest #44.
Describe alternatives you've considered
Perhaps include the blogs in a separate website and link it instead of directly embedding the md file.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
π Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. πππ
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google β€οΈ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.