About | Getting Started | Contributing | Organizers | License
This project is basically a student-developer profile viewer, where students can contribute by submitting a pull request with their profile details. It's being developed to give students a basic introduction to open source contribution in the period of hacktoberfest. Depending on your skill level, you can contribute to the project through.
- Developing the core project (built with Next.js)
- Improving the project documentation
- Creating your own profile (yes, that's also a contribution 😉)
- Testing and fixing issues/bugs
Before contributing, make sure you've signed up for hacktoberfest2021
The project was bootstrapped with Next.js, in order to test, run or contribute make sure you have Node.js installed.
Make a fork of this repository and clone your forked repository.
In the project directory, run this command to install the project dependencies
npm installAfter installing the project dependencies, you can view the project by starting the development server with this command
npm run devBefore contributing, make sure you are familiar with the basics of contributing to a project and ensure you have succesfully setup the project by following instuctions in the getting started section.
To begin contributing, you can look through the project issues to find open issues of task that need to be implemented. If what you are intending to contribute isn't listed in the issues, you can open a new issue stating what you would like to contribute before sending a pull request.
Contribtion can be made in any of the following ways.
Contributing to the documention If you find any typo or feel that documetation is lacking in any way, kindly send a PR. Basically any improvement to the project documentation is highly welcomed.
Contributing by adding your profile to the project
You can also contribute by adding your profile details to the project. This can be done by adding your profile details object to the students array in src/students.js and sending a PR.
Contribuing to the project core This project was created with Next.js. In order to contribute to the project core, you are expected to be familiar with the following web technologies
- HTML
- CSS
- Javascript
- React
- Next.js
- Styled Componnent (used for styling)
Before sending any PR, ensure that you don't have any linting issues, you can verify that by running this command
npm run lintThis project was organized by Kwara State Google Developer Student Club and it is powered by these awesome contributors 🌠