deliverables, tools,

[pbellec]

cool project! You may want to add some of the following info:

• what deliverables will you have? (processed data? scripts? etc)
• You may want to try implementing some analysis with the preprocessed data.
• not clear which tools/skills you are aiming to learn.

[emdupre]

Hi @nooralsh ! Just wanted to drop in and say that what you have is great ! ✨ There's a lot of information to work off. Just to follow up on @pbellec's point, I do think that restructuring the project description would help both clarify your goals and make it easier for others to help you.

What I'd really love to see would be:

• a CONTRIBUTING.md file, where you describe how people can get involved with your project and what skills you're looking for. There's an example that I wrote here, though your focus for contributors will be on brainhack participants, so the file is likely to look a little different. More general guidelines for writing these files are here.
• an ABOUT_ME.md: this would be a great place to put the more general information on your skillset and background, which will help others to know how / when to use you as a resource !
• a roadmap, which lays out the objectives and specific timeline for your project. A great introduction to constructing a roadmap is here.
• then, your README.md would contain more general information on the project, such as your broad objectives and the specific data source you'll be using.

Let me know what you think of this structure ! Happy to sit down and talk through it, as well 😄

[emdupre]

Just to add one major point I forgot— your README.md should also be linking to all of these other resources ! That way it's easy to see where to get relevant information at any stage in your project.

[nooralsh]

Thank you for your feedback @pbellec @emdupre !

I've made some changes to my various .md files. Let me know whether they address your comments appropriately!

Still working on a roadmap :)