From 2701dd33e5f10aac8931d464a1e99a4d24e8cfa2 Mon Sep 17 00:00:00 2001 From: Florin Pop Date: Thu, 28 Feb 2019 23:24:43 +0200 Subject: [PATCH] updated information --- Contribution Guide.md | 6 +++--- Example Guide.md | 6 +++--- README.md | 46 +++++++++++++++++++++++-------------------- 3 files changed, 31 insertions(+), 27 deletions(-) diff --git a/Contribution Guide.md b/Contribution Guide.md index 65676dfe..b9bc806b 100644 --- a/Contribution Guide.md +++ b/Contribution Guide.md @@ -2,10 +2,10 @@ This guide will help us ensure that you have a simple and effective way to contribute to this project. -- If you want to propose a new App Idea, use the [Example Guide](./Example%20Guide.md) as a base template. -- Before creating a Pull Request, please make sure that your suggestion is not already added to the project. You can submit an update if this will improve the existing idea. +- If you want to propose a new App Idea, please use the [Example Guide](./Example%20Guide.md) as a base template. +- Before creating a Pull Request, please make sure that your suggestion is not already added to the project. You can submit an update if you believe it improves an existing idea. - Make sure you check your spelling and grammar. - Create individual PR for each suggestion. - A Trello Board will be created by one of the Team Members after the PR will get merged. -Thank you for spending time improving this project! +Thank you for spending your time to improve this project! ^\_^ diff --git a/Example Guide.md b/Example Guide.md index 04129543..442dfbbb 100644 --- a/Example Guide.md +++ b/Example Guide.md @@ -1,10 +1,10 @@ # Application Name -Add a clear and descriptive description of the application. +Add a clear and descriptive description of the application and it's main features. Answer to the following questions: - "What is the main purpose of this application?" -- "Is there any resource needed in order to complete the project?" - If the answer is yes, make sure you add it +- "Is there any resource needed in order to complete the project?" - If the answer is yes, make sure you add it. ## User Stories @@ -27,4 +27,4 @@ Add all the useful links and resources corresponding to this project. ## Example projects -Add one or more example projects. This will act as a guide for the developer. +Add one or more examples of projects that have similar functionalities to this application. This will act as a guide for the developer. diff --git a/README.md b/README.md index db1e7f4c..5b52773f 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,37 @@ ## App Ideas Collection -Did you ever wanted to build something but you had no idea what to do? +Have you ever wanted to build something but you had no idea what to build or where to start? -Welcome to the **biggest collection** of app ideas you could build to improve your coding skills and why not, to impress your next employer with a shiny portfolio! +Welcome to the **biggest collection** of application ideas. (if not yet, it will be soon enough xD) -Not only that you'll find a list of projects but each project has the following features which will guide you through the process: +These applications are: -1. The main objective of the project -2. A list of minimal _User Stories_ which have to be implemented -3. A list of bonus features to improve the base project -4. A Trello Board that can be cloned and used to track your progress +- great to improve your coding skills; +- great to experiment with new technologies; +- great to be added in your portofolio to impress your next employer; +- great to be used as examples in tutorials (articles or videos); +- easy to complete but also can be extended with new features -### Projects +Not only that you'll find a list of projects but each project has the following features: -| Name | -| ------------------------------------------------------------------ | -| [Book Finder App](./Projects/Book-Finder-App.md) | +1. A clear and descriptive objective; +2. A list of _User Stories_ which should be implemented; (these stories act more as a guideline than a forced list of _ToDo's_. Fell free to add your own features if you want) +3. A list of bonus features that can improve the base project; +4. A Trello Board that can be cloned and used to track your progress; + +## Projects + +| [Book Finder App](./Projects/Book-Finder-App.md) | | [Markdown Table Generator](./Projects/Markdown-Table-Generator.md) | -## Contribution +### Contribution + +Any contributions are highly appreciated. In order to contribute you must fork the project and submit a PR. Before doing that, please make sure that you are reading and following the [Contribution Guide](./Contribution%20Guide.md). + +### Spread the word! -If you want to contribute you can open a PR by following the [Contribution Guide](./Contribution%20Guide.md). +If the information from this repo was useful to you in any way, make sure you give it a star, this way others can find it and benefit too! Together we can grow and make our community better! :) -## To Do +Do you have any suggestions on how we could improve this project overall? Let me know! I'd love to hear your feedback! -- [ ] gather a list of projects to be added in the collection -- [ ] write the main objective for each project -- [ ] write _User Stories_ for the project -- [ ] add bonus features where possible -- [ ] improve the design of the repo by adding images and tags -- [ ] add extra information to the README like: - - [ ] How to use the information in this repo +You can find me on [Twitter](https://twitter.com/florinpop1705) and on my [website](https://florin-pop.com).