firstcontributions / first-contributions Goto Github PK
View Code? Open in Web Editor NEW๐โจ Help beginners to contribute to open source projects
Home Page: https://firstcontributions.github.io
License: MIT License
๐โจ Help beginners to contribute to open source projects
Home Page: https://firstcontributions.github.io
License: MIT License
๐ Problem
You might accidentally commit on the wrong branch
๐ฏ Goal
Make user understand how to move all the changes to a different branch.
๐ก Possible solutions
Add a tutorial in additional material
to address this.
๐ Steps to solve the problem
Addresses #<put issue number here>
The current heading for additional material
on the README
is a little misleading.
๐ Problem
The links at this heading https://github.com/Roshanjossey/first-contributions#-additional-material-
is giving us more information about the Git/Github workflow. But the title of the heading Additional Material
does not convey this, unless one clicks on it and then discovers it.
Renaming this heading to make the hyper-linked content more explicit would help :)
๐ฏ Goal
Make the title of the heading more consistent with the content it points to.
๐ก Possible solutions
Rename the title to Addition Git Information
, Advanced Git Workflow
, Good to Know Git Scenarios
, Advanced Git Techniques
Probable Lables: enhancement
, suggestion
, doc
๐ Problem
Users might have to stop tracking a file on git without removing it
๐ฏ Goal
Make users understand how git rm
works
๐ก Possible solutions
Add a tutorial in additonal-material
to address this.
๐ Steps to solve the problem
Addresses #<put issue number here>
๐ Problem
I am having trouble remembering where different things are on our readme file.
๐ฏ Goal
I would like to easily navigate the tutorials included and different resources
๐ก Possible solutions
I would like to make a link navigation system to different files with the main page split up.
๐ Steps to solve the problem
Project listing might be best kept in web app. There we can have more functionality.
๐ Problem
Current implementation of project listing is constrained by what markdown can do.
๐ฏ Goal
If we move this to web app, we can implement more functionality like filtering, better way of showing information etc.
๐ก Possible solutions
Move the current project suggestion list to web app.
๐ Steps to solve the problem
Addresses #<put issue number here>
Removing duplicate entries from contributor list
๐ Problem
At the moment. contributor list has a lot of duplicates (estimated around 50%)
To make list cleaner, it would be good to remove all duplicates from it
๐ฏ Goal
Have a cleaner list without repeating contributors
๐ก Possible solutions
Removing all repeating entries
๐ Steps to solve the problem
๐ Problem
Git requires to set up user configurations before pushing to remote (GitHub)
๐ฏ Goal
Make user users understand why this is needed. How to do it and what happens behind the scenes
๐ก Possible solutions
Add a tutorial to additonal material
to address this
๐ Steps to solve the problem
Addresses #<put issue number here>
Given that the additional_material folder material will expand in terms of content, it would be better to restructure it a bit, to keep it handy for future use.
๐ Problem
Prevent over-bloating of the additional_materials
folder.
Current Structure:
additional_material
โ translations/
โ git_Q/A1
โ git_Q/A2
โ future_folder/
๐ฏ Goal
Desired structure
additional_material
โ translations/
โ advanced_git/
โ โโโโgit_Q/A1
โ โโโโgit_Q/A2
โ future_folder/
๐ Steps to solve the problem
Lables: enhancement
, doc
This issue is spawned off #802.
๐ Problem
In most open source projects, you have to squash all commits in a pull request. There might be contributors who might not know how to do this
๐ฏ Goal
Help contributors understand what is squashing and how to do it
๐ก Possible solutions
Add a tutorial in additional materials
to address this.
๐ Steps to solve the problem
Addresses #<put issue number here>
๐ Problem
Merge conflicts are a big pain when working with branch-based approach in OSS development
๐ฏ Goal
We wanna make users knowledgeable of what merge conflicts are and how to resolve them.
๐ก Possible solutions
Add a tutorial on how to resolve merge conflicts
๐ Steps to solve the problem
Addresses #<put issue number here>
๐ Problem
When adding my name, I noticed that other people's name were not written properly, which led to:
๐ฏ Goal
To have a better formatted Contributors list.
๐ก Possible solutions
Add a description, with examples, on how to properly add your name to Contributors.md in the README.md file.
๐ Steps to solve the problem
Add description to README.md file.
Update github-desktop-tutorial.md
to reflect the new Github Desktop 1.0 client.
๐ Problem
Github Desktop 1.0 was announced on September 19. The new version includes quite a few changes in UI compared to the version in github-desktop-tutorial.md
๐ฏ Goal
Make it easier for (new) users with Github Desktop 1.0 and above following the tutorial.
๐ก Possible solutions
Update the text and screenshots in github-desktop-tutorial.md
for Github Desktop 1.0
๐ Steps to solve the problem
Addresses #<put issue number here>
๐ Problem
The first link under the Useful links section of this page is broken.
๐ก Possible solutions
Point it to the correct hyperlink, I guess it should point to the additional_material
folder instead.
Labels: bug
JS Code to flatten an array
๐ Problem
Given a nested array say [1,[2,3],[4,[5,6],7],8,9,10]
๐ฏ Goal
The objective is to flatten it completely like [1,2,3,4,5,6,7,8,9,10]
Follow the tutorial in readme and add your name to Contributors.md
Translations were done when tutorial was evolving. This led to some translations not being in sync with the base tutorial
๐ Problem
Translations of tutorial is not up-to-date with tutorial (Readme) in English
๐ฏ Goal
Get all translations synced with English version
๐ก Possible solutions
Check for differences between English version and other languages, Make necessary changes
๐ Steps to solve the problem
Addresses #<put issue number here>
๐ Translations to be synced
๐ Problem
When following some links (Fun Retros, react, Node) from README.md, the github page shows "No results matched your search" which might lead the beginner contributor to think there are no beginner-level issue.
๐ฏ Goal
To point the links to the proper list of issues (filtered using the proper labels)
๐ก Possible solutions
Update the links
๐ Steps to solve the problem
Addresses #<put issue number here>
๐ Problem
While working with git, you might have to undo commits that were done before
๐ฏ Goal
Help users understand how to revert commits, problems it might cause, how to do it
๐ก Possible solutions
Add a tutorial to revert commit
๐ Problem
Tweet shared currently has hacktoberfest hash tag. This is not needed anymore as hacktoberfest ended.
๐ฏ Goal
Have a better tweet text
๐ก Possible solutions
You can find the code for tweet button in
https://github.com/Roshanjossey/first-contributions/blob/master/app/src/components/SocialShare/Twitter.jsx
In twitterLink, remove hacktoberfest hashtag and put something more appropriate
๐ Steps to solve the problem
Addresses #<put issue number here>
It'd be awesome to have a lot more suggested projects
๐ Problem
Currently we have only a bunch of projects in project suggestions
๐ฏ Goal
Have a lot of project suggestions from diverse domains, languages, frameworks
๐ก Possible solutions
Add new projects.
We maintain the list of projects at https://github.com/Roshanjossey/first-contributions/blob/master/app/src/components/ProjectList/listOfProjects.js
Change this file and add details of new project. Make sure you add all fields like other projects you see there
Don't know any projects you wanna add? Check out https://github.com/MunGell/awesome-for-beginners where there's a list of a boatload of projects
๐ Steps to solve the problem
Addresses #<put issue number here>
After runnning npm start, a error is thrown.
๐ Problem
npm ERR! Windows_NT 10.0.15063
npm ERR! argv "C:\Program Files\nodejs\node.exe" "C:\Program Files\nodejs\node_modules\npm\bin\npm-cli.js" "start"
npm ERR! node v6.11.2
npm ERR! npm v3.10.10
npm ERR! file C:\Users\Manuka Maduranga\Desktop\Hacktober\first-contributions\app\package.json
npm ERR! code EJSONPARSE
npm ERR! Failed to parse json
npm ERR! Unexpected token 'r' at 11:6
npm ERR! "react-test-renderer": "^15.0.0",
npm ERR! ^
npm ERR! File: C:\Users\Manuka Maduranga\Desktop\Hacktober\first-contributions\app\package.json
npm ERR! Failed to parse package.json data.
npm ERR! package.json must be actual JSON, not just JavaScript.
npm ERR!
npm ERR! This is not a bug in npm.
npm ERR! Tell the package author to fix their package.json file. JSON.parse
npm ERR! Please include the following file with any support request:
npm ERR! C:\Users\Manuka Maduranga\Desktop\Hacktober\first-contributions\app\npm-debug.log
๐ฏ Goal
๐ก Possible solutions
๐ Steps to solve the problem
Addresses #<put issue number here>
Currently the GitHub tutorial section on the web-page has only one project. We can add more tutorial to it, and help the beginner pick and choose from diverse sources.
๐ก Possible solutions
Resources to add, if not added already.
Labels: ehancement
๐ Problem
Web app doesn't render well on small screens
๐ฏ Goal
It should look good on smaller screens too.
๐ก Possible solutions
๐ Steps to solve the problem
Addresses #<put issue number here>
๐ Problem
We might not be reaching to a lot of our target audience through resources we're using now
๐ฏ Goal
Reach out to more people.
๐ก Possible solutions
Add Facebook share to web app so that users can share the news of their first contribution with their friends and followers
๐ Steps to solve the problem
Addresses #<put issue number here>
Good day,
My first contribution to GitHub ever was yesterday and I've only followed your tutorial to get there.
So first, thank you very much!
However, there is a few things I have picked up along the way: Everything is flowing great in the readme...The new comer pushes its local machine repo back to his GitHub profile repo and then Requests a pull onto the original Roshanjossey/first-contribution repo. However, after I asked for a pull request, I continued the steps "Keeping your fork synced" and the problems were that my neat Pull request couldn't be accepted because 7 commands later I had deleted the repo with git push origin --delete <add-your-name>
๐ Problem
origin <add-your-name>
to the master branch on Roshanjossey/first-contribution.git push origin --delete <add-your-name>
I didn't realise that Roshanjossey wouldn't be able to accept my earlier pull request anymore if I deleted my branch on my GitHub repo.
git fetch upstream
" every day, or what you mean by "it's synced"...if it's synced like an android with "sync on" or not.Furthermore, I don't know what would happen if I did git push upstream master
. Do I simply get a request for a login/password which I won't have so it wouldn't matter, or will it push through to your main repo direct and mess up everyone else's code? (I actually don't want to try, just in case the latter applies hahahaha)
๐ฏ Goal
To be more specific of what a new contributor is supposed to do or not to do to get a successful first "pull request", without my unfortunate mistake being re-iterated by everyone alike me.
To be more detailed about what git fetch upstream
is and how it's supposed to be used.
To know what would happen if I did a git push upstream master
๐ก Possible solutions
<add-my-name>
branch, it doesn't make a difference as you would request a pull between the two masters.-Second solution could be to explain that if a contributor asked for a "pull request" as shown a couple of commands earlier, the new contributor needs to wait for the pull request to be accepted before deleting that <add-your-name>
branch.
๐ Steps to solve the problem
Addresses #<put issue number here>
Currently, the Get Started
button is placed on a new line after the headline Make your first open source contribution in 5 minutes
. Since the Get Started
button is w.r.t to the headline, it makes more sense to have it next to the heading.
๐ Problem
With Get Started
button on a separate line, it seems as if the heading is one context and the button another, while they a part of the same context of bringing users to the First Contributions
Page. A little relocation of the button can help make the context switch from site to the README smoother.
๐ฏ Goal
It makes the transition to opening the First Contributions
page easier. Should provide a better user experience.
๐ก Possible solutions
Relocate the Get Started
button to the heading.
Suitable Labels: enhancement
, suggestion
A landing page for First contributions will bring a better look to the project
๐ Problem
Jumping directly in to project readme is not cool enough.
๐ฏ Goal
Create a landing page. This will help in working on additional features in the app too.
๐ Problem
It's hard to know what language a project is written in or what kind of project it is from the current project listing
๐ฏ Goal
Users should be able to understand the language used in a project or what the project is about easily.
๐ก Possible solutions
Add tags to project cards in the list. Here's a mock-up of the proposed solution
Please don't try to make changes to exactly match this. Look and feel can be improved a lot.
๐ Steps to solve the problem
Addresses #<put issue number here>
We have an additional material section that has additional content that can be used after the first contribution.
https://github.com/Roshanjossey/first-contributions/blob/master/additional-material/additional-material.md
๐ Problem
We don't have a lot of content there. We lack content for many problems beginners may face.
๐ฏ Goal
Have a big FAQ of sorts that can explain processes of doing something to what each git command does
๐ก Possible solutions
We'll come up with general problems we wanna address. Spawn issues from this so that people can write content to address that.
๐ Steps to solve the problem
๐ Content to be added
๐ Problem
Hello all , The instructions for how to make your first contributions are rather good , but at the portion where one is told to save the Contributors.md file and how to check it's status . I found that ,as a newbie, it was not clear for example : if the file needed to be saved in a certain location etc or what to do if, like me, it did not upload correctly I think that since this is geared toward beginners etc that perhaps a more detailed explanation in this portion would be helpful. Thank you for all the great help . this place rocks .
๐ฏ Goal
I feel this would help individuals to have an ever better understanding of the git process etc.
If you feel like this is an issue we should address, please vote with adding ๐ if not, do a ๐
I can translate it and send you a Pull request if you are interested.
This issue is spawned off #802.
How to do git reset (both soft and hard)
๐ Problem
Users might have to undo commits
๐ฏ Goal
Make users understand how to reset
๐ก Possible solutions
Add a tutorial in additional materials to address this.
๐ Steps to solve the problem
Addresses #<put issue number here>
๐ Problem
links to github desktop, Visual Studio 2017 and gitkarent are not correct for many language
๐ฏ Goal
๐ก Possible solutions
๐ Steps to solve the problem
I'll work on it today
This issue isn't about the problem. It suggest to use ESLint
with Airbnb Javascript Guide in webapp.
If we don't start with a good project structure and don't using code style guide
, it will become more hard to organize the project and code.
When we using code style guide
, we can get many benfits.
That are -
We can make easy to add this feature by using ESLinter
with eslint-config-airbnb package and own custom rules. eslint-config-airbnb are follow rules of Airbnb Javascript Style
. Most of the popular project are also used the Airbnb Javascript Style
because of it contains more styles of modern javascript like ES6.
Addresses #<put issue number here>
We have many translation languages. But some of the translation language pages have not complete to jump another translated language pages. I think we must need translation guide page.
Every translation pages have all translated page links. More smart.
We must need to add translation guide for translator. It will include some of translation rule.
Sorry for my english skill.
I think translation links format is inline rather than bullet list or table with country flag.
Country | Translated Link |
---|---|
๐ฎ๐ณ India | Hindi |
๐ฒ๐ฒ Myanmar | Myanmar Unicode, Myanmar ZawGyi |
A cooler background can really lift the looks of first contributions
๐ Problem
Currently header background is plane. It could be better if there was some additional graphics to improve the looks
๐ก Possible solutions
There could be some graphics related to git or branches.
I like the ones in https://opensource.google.com/ and https://about.gitlab.com/
๐ Steps to solve the problem
Addresses #<put issue number here>
This issue is split into two ideas that I think can only act together.
Add a version or revision number of the README file, so that one can easily see if he's dealing with the newest additions.
Also adding comments with the least revision change could also help translators.
๐ Problem
New users won't know if their translation is bleeding edge or a rotten tomato. Adding a revision number would help them a bit.
Also keeping the translations up-to-date might be an annoying task, as it is needed to read the whole file and look for differences - in two languages.
๐ฏ Goal
As a user can easily compare by the revision number, he can see if the translation is up-to-date or lacking updates. Therefore it might be an easier step for non-native speakers to take their language for the tutorial, if they can be sure they have the same features in it.
To not have translators read the whole readme (both english and in their prefered language), revision comments could help them to compare changes. If a new revision comes out, they just have to adjust the section which now have a smaller revision number than the English readme. This would make updating the tutorials much more convenient.
๐ก Possible solutions
Just add a "Revision [Number]" at the top of the readme, maybe as a badge. I would call it revision and not version, because a version might tell the user they're actually missing some features. This project is pretty straight-forward and already has its features implemented - for now we optimise it. Revision might be the proper term IMHO.
Adding a comment (e.g. <!-- Revision 4 -->
) to each major/minor section. For example at every big and small headline. Sections that are not changed in a new commit just stay at their revision state. Only new/changed sections count up their revision number by 1. Translators then can look up the revision of their language and easily scroll through the English readme and see which sections stayed the same and which ones require an update.
๐ Steps to solve the problem
๐ Problem
The chapter `Keeping your fork synced with this repository mentions that a drawing should be added to clarify the concept. This remark should be handled as an issue and not as a remark in the tutorial.
๐ฏ Goal
Make the concept of remote and local forks easier to understand.
๐ก Possible solutions
Add a drawing and integrate it to /additional-material/keeping-your-fork-synced-with-this-repository.md
๐ Steps to solve the problem
Add a twitter share button to web app https://roshanjossey.github.io/first-contributions
๐ Problem
We're missing out on reaching out to a lot of users because we're not leveraging the complete potential of social media marketing.
๐ฏ Goal
๐ก Possible solutions
Add a tweet button to web app. Add a link to web app so that users can go there and share their first contribution.
๐ Steps to solve the problem
Addresses #<put issue number here>
Here's some materials to get you started
This comes after moving issues to webapp #128
๐ Problem
Users prefers to filter projects to those they'd love to contribute to rather than going through all projects in the list
๐ฏ Goal
Users should be able to easily find projects they're interested in.
๐ก Possible solutions
Filter projects based on programming language, framework used, domain etc
๐ Steps to solve the problem
Addresses #<put issue number here>
Some Improvements/Suggestion on making the web app more organize and improve UX.
๐ Problem
P.S. All of this is just a suggestion and of course, not everyone has the same preference.
๐ฏ Goal
Improve the user experience on the web app.
๐ก Possible solutions
I'll provide a brief pic of my suggestion to each issues.
๐ Steps to solve the problem
Addresses #<put issue number here>
In Keeping your fork synced with this repository
section, users might by mistake merge upstream changes with some branch other than master
๐ Problem
While going through the tutorial, users might be on the branch they created to add their name to contributors list while doing fetching and merging from upstream. This is not what we want.
๐ฏ Goal
Users should understand the need for fetching from upstream and why it should be merged to master. Users should be able to repeat this in any other open source project they work on.
๐ก Possible solutions
Add another command like git checkout master
with necessary information on why do it before fetching.
๐ Steps to solve the problem
Addresses #<put issue number here>
Node.js has a label for "good first contribution" too.
๐ Problem
Currently the tutorial aims only at people using Linux or macOs operating system and who uses command line git tool.
It might be good to entertain users who don't fall in to this category too.
๐ฏ Goal
Address users across platforms and tools. We can have multiple versions of the tutorial and link each of them in main Readme.
๐ Steps to solve the problem
Addresses #80
๐ Operating system/ tool for which tutorial should be added
WIP
If the tool or operating system you use is not listed, please comment below. We'll add it
@Thrasheristico had previously put a comment about this in #79
๐ Problem
It's not very easy to add projects to suggestions
๐ฏ Goal
Make it simple for anyone to add projects to suggestions
๐ก Possible solutions
Add a Add project
button to web app. On clicking it, open a form to add details about the project. On submitting this form, open a pull request in this project with those changes
๐ Steps to solve the problem
Addresses #<put issue number here>
@sotayamashita would you like to take this up or share this with some one who you'd think is up for the task?
๐ Problem
The Visual Studio image is not showing in Chrome.
๐ Problem
Currently we have default react favicon
๐ฏ Goal
It'd be great to put first contributions icon as favicon
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.