Add contribution guidelines

Jonatha-Varjao / seccomp-qr-precense

App build with flutter for precense validations at SECCOMP's courses and lectures

MIT License

1 stars 0 forks source link

Add contribution guidelines #1

Open paulorobertocruz opened 5 years ago

paulorobertocruz commented 5 years ago

For future reference and potential contributions made to the app we need guidelines.

Code style
Project structure
Roadmap

All of then is good but if the roadmap is present we can figerout the other stuff as we go. Assuming you want some help.

Just a conversations starter.

Jonatha-Varjao commented 5 years ago

Nice addition, I'm gonna create the project guidelines and upload as soon as I finished it and also the Road Map.

But basically, I'm gonna try to use Provider pattern, instead of the scoped model or BloC.

The purpose of this app is for the SECCOMP annuals, it will be used by the staff, the initial MVP is only 3 views:

Landing Page -- List with Lectures -- List with Courses
Info about Lecture/Courses - 3 options will appear ( Check-in, Check-out ) -- Button for Check-in / Check-out.
View for the QR scan and send the information for any database plugged in the endpoint (Firebase, Mongo) -- An modal to check if the info was sent or any error catched.

This is the initial approach, any feedback is welcome.

paulorobertocruz commented 5 years ago

simple, but i dont understand who will operate this app, attendees or staff? And also what informations will be presented in the qr code?

Jonatha-Varjao commented 5 years ago

Basically the QR is a mimic to a student/person registered at seccomp, at the reading we can show the person infos ( photo, name, etc.). This app will be operated by the staff.

paulorobertocruz commented 5 years ago

no login required right?

Jonatha-Varjao commented 5 years ago

A priori it isn't required, but we can use an OAuth with some predetermined e-mails for login (the staff only) or some increased security manners for denying non-staff users access ?? Right now the focus is to implement the MVP, and this project can be scaled up within the years to come as a project being directed by a Computer Science Professor ??? It's just ideas in the air for now.....

paulorobertocruz commented 5 years ago

i think that is ok without login for now.