Giter VIP home page Giter VIP logo

amyyalex / simple-contribution Goto Github PK

View Code? Open in Web Editor NEW
50.0 3.0 144.0 984 KB

This is a very simple project to help first-time contributors to easily participate in an open-source project.

Home Page: https://amyyalex.github.io/simple-contribution/

License: MIT License

HTML 22.52% CSS 49.65% JavaScript 27.83%
begineers beginner-project contributions css github-desktop good-first-issue html open-source

simple-contribution's Introduction

simple-contribution

Click on the link to see the live site!

Introduction

Hey there! Welcome to the Simple Contribution repo. This is a very simple web project to help first-time contributors easily participate and contribute to open source projects and also get more comfortable in using GitHub. Who knows - our "simple" contribution may become something amazing!

Who can contribute?

This project is for both developers and non-developers. Anyone can contribute to this project, developer or otherwise, as long as you want to contribute to an open source project. This is intended for complete beginners and also for those with a little more experience who want to make their first open source contribution and gain more experience.

How and what do I contribute?

It's simple, open up the cardDetails.json file and add your details to it, ypu can easily copy any one of the JSON objects and customize it with your own information. To contribute, read the Contribution guide to get an explicit guide on the whole process of contributing starting from setting up Github to creating a pull request. If you're an advanced developer and you want to take it up a notch, read the Advanced Contribution guide to get started.

Once your pull request is merged, the changes will be live on simple-contribution. If you appericate this amazing project, kindly leave a โญ by clicking on the star button on the top right. Thank you!

๐Ÿค Contributors

Thanks goes to these wonderful people:

simple-contribution's People

Contributors

abdessamadtzn avatar ademola111 avatar amyyalex avatar anishyakk avatar ankurnegigithub avatar azick99 avatar banitongwa7 avatar bthomas22tech avatar carmenbelle avatar coderblee avatar ctokoli avatar danyalejaz avatar elisiomassaqui avatar favy-codez avatar gameliaprogrammer avatar jaypee15 avatar kelvinokumu avatar mrashwin2142 avatar musangisilvia avatar s-shemmee avatar sab3ha avatar solarsoft0 avatar soyoonmoon avatar sreekakulamlohith avatar superfly101 avatar tataw-cl avatar tonybnya avatar vince-arch avatar vivienogoun avatar wesley-waka 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

Watchers

 avatar  avatar  avatar

simple-contribution's Issues

Improve the app.js file

Over time, the number of contributors could exceed a thousand. We should separate the Card details from the app.js file by creating a separate json file. So, any new contributor who wishes to add their card will do so in the json file. This would easily maintain the contents of the app.js.

How to proceed ?

  • Create a cardDetails.jsonfile
  • Move the content of cardDetailsArray into cardDetails.json file
  • Update the cardDetailsArray varaible so that it import cardDetails.json

Element misalignment and visibility issue on medium-sized screens

Element Misalignment

  • The "Add Your Contribution" and "Search" elements are in a single row, but they are not aligned properly.
  • "Search" Element can be made vertically center to make it visually more appealing

Visibility issue on medium-sized screens

  • On medium-sized screens (760px - 1100px), the "Search" element is hidden.

Steps to Reproduce:

  1. Open the application on a device with a medium-sized screen (e.g., tablet).
  2. Navigate to the section containing the "Add Your Contribution" and "Search" elements.
  3. Observe the alignment of the elements in the row.
  4. Check if the "Search" element is visible on medium-sized screens.

ScreenShot
simpleContribution

Improve banner design

The current banner in the project serves as a vital element but may benefit from enhancements to improve its visual appeal, messaging, or functionality. This task aims to elevate the banner's overall quality and effectiveness.

Tasks:

  • Refine the visual aesthetics, retaining the colour scheme and layout.
  • Add animation or interactive elements to make the banner more engaging.
  • Enhance the banner's responsiveness across different screen sizes and devices.

Acceptance Criteria:

  • Improved banner design is visually appealing and grabs user attention effectively.
  • Any text or call-to-action within the banner is retained, clear and easily readable.
  • Banner enhancements do not negatively impact page load times or usability.

Implement search functionality with alphabetical sorting for names

This issue aims to implement a search functionality that when a letter is keyed in, all names starting with letter shows and the results sorted alphabetically based on the entered letter. Additionally, this enhancement includes the creation of a function to sort names under the searched letter.

Tasks:

  • Develop a search feature that accepts user input to search for names.
  • Implement an alphabetical sorting function for displaying names under the searched letter.
  • Create a filter mechanism to categorize names according to the searched letter.
  • Integrate the search functionality with the alphabetical sorting feature.
  • Perform thorough testing to ensure accurate search results and alphabetical sorting.

Acceptance Criteria:

  • Users can input letters to search for specific names.
  • Search results are sorted alphabetically and displayed under the respective searched letter.
  • Names are properly indexed and categorized based on the entered letter.
  • The implemented search functionality works smoothly without any glitches or errors.

[FEATURE] Add pagination to the page

The current interface displays all objects at once, resulting in a long list as more objects are added. Introducing pagination will improve the user interface by limiting the number of objects shown per page, enhancing readability and user experience.

Tasks:

  • Implement pagination functionality using HTML, CSS, and JavaScript.
  • Design a user-friendly pagination UI element.
  • Integrate pagination logic to display a set number of objects per page.
  • Ensure seamless navigation between pages without affecting existing functionalities.

Acceptance Criteria:

  • Pagination controls are visible and intuitive for users.
  • Objects are displayed in a paginated manner, reducing clutter on a single page.

[FEATURE]: Add language selector

Currently, the project lacks the ability for users to select their preferred language. Adding a language selector will allow users to switch between different languages, improving accessibility and usability for a wider audience.

Tasks:

  • Integrate language translation functionality.
  • Create language-specific versions of content or utilize a translation service/API.
  • Design and style the language selector to be user-friendly and accessible.
  • Test thoroughly to ensure proper functionality and accurate translations for selected languages.

Acceptance Criteria:

  • The language selector is prominently displayed and easily accessible to users.
  • Users can switch between languages, and the content is displayed in the selected language.
  • Ensure compatibility and responsiveness across various devices and screen sizes.

Enhance Readme with Dynamically Fetched Contributors' Avatars

๐Ÿš€ Feature Proposal

Proposed Solution
Integrate a dynamic solution that fetches contributors' avatars from their GitHub profiles and displays them in the Readme. This will not only showcase the diverse community contributing to the project but also add a personal touch to the documentation.

Motivation

Adding dynamically fetched contributors' avatars to the Readme file is not just a cosmetic enhancement; it's a visual celebration of our contributors' invaluable efforts. This addition fosters a stronger sense of community, encouraging both new and existing contributors to feel recognized and connected to the project. Let's make our Readme reflect the vibrant and diverse community that drives the success of our open-source endeavor.

Example ( Following will be exactly added to your readme file.)

๐Ÿค Contributors

Thanks go to these wonderful people:

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.