Coder Social home page Coder Social logo

firstcontributions / first-contributions Goto Github PK

View Code? Open in Web Editor NEW
43.0K 509.0 74.3K 40.69 MB

๐Ÿš€โœจ Help beginners to contribute to open source projects

Home Page: https://firstcontributions.github.io

License: MIT License

open-source tutorial contribution community tutorials beginner beginner-friendly contributions contributions-welcome good-first-issue

first-contributions's People

Contributors

4rass avatar aadij2022 avatar archielicious avatar cherxoxo10 avatar cisco2001 avatar creator0131 avatar dhruvt0510 avatar elinoza avatar firstcontributions-bot avatar frozenexplorer avatar hamdivazim avatar harohar13 avatar harshalhonde21 avatar harshhere905 avatar hephzy-1 avatar limiting-ongoing-work avatar mantis964 avatar mzf11125 avatar newstart70 avatar oye-aryan avatar porfanid avatar roshanjossey avatar samridh31 avatar sauravhingade avatar scaulfield7 avatar sureshp820 avatar tanishq2807 avatar vikhyat0908 avatar vinayakwaghmode7 avatar zorodoescoding avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

first-contributions's Issues

Add a tutorial in additional materials on how to move a commit to a different branch

๐Ÿž 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

  • Comment below about what you've started working on.
  • Add, commit, push your changes
  • Submit a pull request and add this in comments - Addresses #<put issue number here>
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project ๐ŸŽ‰

Rename Heading from additional-material to include the work git/workflow

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

Add a tutorial in additional materials on how to remove a file from git without removing from file system

๐Ÿž 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

  • Comment below about what you've started working on.
  • Add, commit, push your changes
  • Submit a pull request and add this in comments - Addresses #<put issue number here>
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project ๐ŸŽ‰

Ease of Refrence

๐Ÿž 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

  • I will create different files with the page divided
  • I will include links to the other pages on each one
  • I will learn GitKracken and anything else that will help me (personal goal)
  • Celebrate your contribution to this project ๐ŸŽ‰

Move project listings to web app

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

  • Comment below about what you've started working on.
  • Add, commit, push your changes
  • Submit a pull request and add this in comments - Addresses #<put issue number here>
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project ๐ŸŽ‰

Cleaning Contributor List duplicates

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

  • Removing duplicated entries in some automatised way (plugin, regex, etc..)
  • Carefully reviewing in no contributor name is lost during automatised removal process

Add a tutorial in additional materials on how to configure username and email for git

๐Ÿž 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

  • Comment below about what you've started working on.
  • Add, commit, push your changes
  • Submit a pull request and add this in comments - Addresses #<put issue number here>
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project ๐ŸŽ‰

Additional Material folder enhancement.

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

  • Put all Advanced git scenario files under a folder, makes it easier to expand the senarios
  • List the advanced git scenarios in additional material in alphabetical order,so that s through scenarios becomes easier.
  • Have this section at the end of the file
  • Fix any broken hyperlink, eg: #2230

Lables: enhancement, doc

Add a tutorial in additional materials on how to squash commits

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

  • Comment below about what you've started working on.
  • Add, commit, push your changes
  • Submit a pull request and add this in comments - Addresses #<put issue number here>
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project ๐ŸŽ‰

Add a tutorial in additional materials on how to resolve merge conflicts

๐Ÿž 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

  • Comment below about what you've started working on.
  • Add, commit, push your changes
  • Submit a pull request and add this in comments - Addresses #<put issue number here>
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project ๐ŸŽ‰

Add format description on how to add your name to Contributors.md

๐Ÿž Problem
When adding my name, I noticed that other people's name were not written properly, which led to:

  • name not being displayed when viewing the document (when adding a space before the hyphen)
  • name with extra characters (when adding brackets and no giuthub url)
  • name not being linked to github url (when adding a space between the name and the url)

๐ŸŽฏ 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 for Github Desktop 1.0

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

  • Comment below about what you've started working on.
  • Add, commit, push your changes
  • Submit a pull request and add this in comments - Addresses #<put issue number here>
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project ๐ŸŽ‰

Broken Hyperlink

๐Ÿž 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

Issue - Flatten an array JS

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]

Translations are not up-to-date

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

  • Find a language from the list below which is unchecked. ๐Ÿ”ฒ
  • Comment below about what you've started working on.
  • Find changes required, make those changes.
  • Add, commit, push your changes
  • Submit a pull request and add this in comments - Addresses #<put issue number here>
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project ๐ŸŽ‰

๐Ÿ“‹ Translations to be synced

  • Spanish
  • Dutch
  • Hindi
  • Russian
  • Japanese
  • Vietnamese
  • Polish
  • Korean
  • German
  • Simplified Chinese
  • Traditional Chinese
  • Greek.

Some links in the project links have incorrect/outdated label names

๐Ÿž 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

  • Comment below about what you've started working on.
  • Add, commit, push your changes
  • Submit a pull request and add this in comments - Addresses #<put issue number here>
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project ๐ŸŽ‰

Add a tutorial in additional materials on how to revert a commit

๐Ÿž 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

Update tweet text

๐Ÿž 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

  • Comment below about what you've started working on.
  • Add, commit, push your changes
  • Submit a pull request and add this in comments - Addresses #<put issue number here>
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project ๐ŸŽ‰

Add projects to project list

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

  • Comment below about what you've started working on.
  • Add, commit, push your changes
  • Submit a pull request and add this in comments - Addresses #<put issue number here>
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project ๐ŸŽ‰

Error in package.json when building

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

  • Comment below about what you've started working on.
  • Add, commit, push your changes
  • Submit a pull request and add this in comments - Addresses #<put issue number here>
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project ๐ŸŽ‰

Add more sources for the Github/Tutorial filter tag.

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

Web app is not responsive now

๐Ÿž Problem

Web app doesn't render well on small screens

๐ŸŽฏ Goal

It should look good on smaller screens too.

๐Ÿ’ก Possible solutions

Make it responsive
Responsive

๐Ÿ“‹ Steps to solve the problem

  • Comment below about what you've started working on.
  • Add, commit, push your changes
  • Submit a pull request and add this in comments - Addresses #<put issue number here>
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project ๐ŸŽ‰

Add facebook share to web app

๐Ÿž 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

  • Comment below about what you've started working on.
  • Add, commit, push your changes
  • Submit a pull request and add this in comments - Addresses #<put issue number here>
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project ๐ŸŽ‰

Needs for Clarification Concerning the Readme Steps

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

  1. We asked me to do a pull request from my GitHub repo origin <add-your-name> to the master branch on Roshanjossey/first-contribution.
    However, 7 commands later in the Readme, we actually make me delete that same repo I requested to be pulled with:
    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.

  1. I'm not sure if I'm supposed to type "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

  1. 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.

  2. 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

  1. I guess, one could go two ways: -Within the local machine, before the push to my origin, merge branch to master. So that when we delete the <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.

  1. A one-liner saying: "Hey, you should use the fetch once a day or so" or "Hey, now you are in a one-way sync, you never need to worry about this command again your repo will always be up-to-date automatically" (The former I believe might be the right answer)

๐Ÿ“‹ Steps to solve the problem

  • Comment below about what you've started working on.
  • Add, commit, push your changes
  • Submit a pull request and add this in comments - Addresses #<put issue number here>
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project ๐ŸŽ‰

The Get Started button fits better with the heading line.

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

Create a landing page for first contributions

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.

Add tags to project listing

๐Ÿž 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

screen shot 2017-10-20 at 1 45 49 am

Please don't try to make changes to exactly match this. Look and feel can be improved a lot.

๐Ÿ“‹ Steps to solve the problem

Add more content to additional material

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

  • Comment below about what you'd like to have in additional materials
  • I'll add them to the list below
  • We'll create an issue for each piece of work
  • We'll request for a pull request to address that issue

๐Ÿ“‹ Content to be added

  • How to squash commits
  • How to resolve merge conflicts
  • Undo local commits
  • Remove a file from git without removing from file system
  • Edit a commit message
  • Revert pushed commits
  • Configure username and email for git
  • How to move a commit to different branch

Provide further details in First Contributions .

๐Ÿž 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 ๐Ÿ‘Ž

Add a tutorial in additional materials on how to undo local commits

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

  • Comment below about what you've started working on.
  • Add, commit, push your changes
  • Submit a pull request and add this in comments - Addresses #<put issue number here>
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project ๐ŸŽ‰

Fix links of section "tutorial using other tools"

๐Ÿž 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

Add Javascript Style Guide for Webapp

๐Ÿž Problem

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.

๐ŸŽฏ Goal

When we using code style guide, we can get many benfits.
That are -

  • reduce code
  • reduce unnecessary declaration variables, function and etc.
  • easy to understandable
  • more clean code

๐Ÿ’ก Possible solutions

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.

๐Ÿ“‹ Steps to solve the problem

  • Comment below about what you've started working on.
  • Add, commit, push your changes
  • Submit a pull request and add this in comments - Addresses #<put issue number here>
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project ๐ŸŽ‰

Languages List for more smart

๐Ÿž Problem

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.

๐ŸŽฏ Goal

Every translation pages have all translated page links. More smart.

๐Ÿ’ก Possible solutions

We must need to add translation guide for translator. It will include some of translation rule.

Example of rules -

  • First translator must add your language link to all of translated pages.

๐Ÿ“‹ Steps to solve the problem

  • Add translation guide for translator with some rule
  • Translators must follow the translation guide
  • Submit a pull request and add this in comments
  • Ask for a review in comments section of pull request

๐Ÿฅ‡ Additional

Sorry for my english skill.
I think translation links format is inline rather than bullet list or table with country flag.

Example of bullet list -

Example of table -

Country Translated Link
๐Ÿ‡ฎ๐Ÿ‡ณ India Hindi
๐Ÿ‡ฒ๐Ÿ‡ฒ Myanmar Myanmar Unicode, Myanmar ZawGyi

Cool background for header in web app

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

  • Comment below about what you've started working on.
  • Add, commit, push your changes
  • Submit a pull request and add this in comments - Addresses #<put issue number here>
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project ๐ŸŽ‰

Add a version or revision indicator

This issue is split into two ideas that I think can only act together.

  1. Add a version or revision number of the README file, so that one can easily see if he's dealing with the newest additions.

  2. Also adding comments with the least revision change could also help translators.

๐Ÿž Problem

  1. New users won't know if their translation is bleeding edge or a rotten tomato. Adding a revision number would help them a bit.

  2. 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

  1. 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.

  2. 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

  1. 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.

  2. 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

  1. Add indicators
  2. โ€ฆ
  3. Profit!

Add a drawing to clarify the full sync workflow

๐Ÿž 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 drawing
  • Add it to /additional-material/keeping-your-fork-synced-with-this-repository.md

Add tweet button to web app

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

Reach out to more people.
I like it

๐Ÿ’ก 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

  • Comment below about what you've started working on.
  • Add, commit, push your changes
  • Submit a pull request and add this in comments - Addresses #<put issue number here>
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project ๐ŸŽ‰, Don't forget to tweet ๐Ÿ˜‰

Here's some materials to get you started

Filter projects based on language / framework / domain

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

  • Comment below about what you've started working on.
  • Add, commit, push your changes
  • Submit a pull request and add this in comments - Addresses #<put issue number here>
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project ๐ŸŽ‰

Suggestion on the design of the web app

Some Improvements/Suggestion on making the web app more organize and improve UX.

๐Ÿž Problem

  1. The list of project is a bit too wide. Can consider making the width smaller and maybe put a container around them.
  2. The social media should be after the header and before the list of projects. So that, it's more easily accessible.
  3. The filter project can be on top of the project list, with a search feature(maybe?).
  4. Try to standard all project card size. Eg. Some of the image is longer while some shorter, the card description should have the same size even though some is longer/shorter.

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

  • Comment below about what you've started working on.
  • Add, commit, push your changes
  • Submit a pull request and add this in comments - Addresses #<put issue number here>
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project ๐ŸŽ‰

Users might not sync upstream changes with master branch while merging

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

  • Comment below that you wanna take it up.
  • Add the required command and description.
  • Add, commit, push your changes
  • Submit a pull request and add this in comments - Addresses #<put issue number here>
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project ๐ŸŽ‰

Tutorial is specific for users of *nix platform and git command line tool

๐Ÿž 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

  • Learn how to submit a pull request if you haven't done that already (just follow the tutorial in Readme)
  • Find a platform/tool from the list below which has checkbox unchecked ๐Ÿ”ฒ
  • Comment below about what you've started working on.
  • Make a separate file for the tutorial and add a link to it in all Readme files (Include translation files)
  • Add, commit, push your changes
  • Submit a pull request and add this in comments - Addresses #80
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project ๐ŸŽ‰

๐Ÿ“‹ Operating system/ tool for which tutorial should be added

  • Windows
  • Github desktop app
  • GitKraken 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

[SEV-1][BUG]Incorrect rendering of the site on Fedora-Firefox

๐Ÿž Problem
The webiste is not rendering properly on Firefox.
Configuration:
Firefox: 57.0.4
OS: Fedora 27
screenshot from 2018-01-14 18-13-21

screenshot from 2018-01-14 18-13-45

The same site is rendering properly when run from my system via Google Chrome:
Configuration:
Chrome: Version 63.0.3239.132
screenshot from 2018-01-14 18-13-52

Labels: bug, SEV-1 High Priority

Add project button in web app

๐Ÿž 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

  • Comment below about what you've started working on.
  • Add, commit, push your changes
  • Submit a pull request and add this in comments - Addresses #<put issue number here>
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project ๐ŸŽ‰

Change favicon

๐Ÿž Problem

Currently we have default react favicon

๐ŸŽฏ Goal

It'd be great to put first contributions icon as favicon

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.