Document updates - Githubissues

NitinNair89 commented 4 years ago

@maaxow - Let's update all the documents as necessary so that this repo becomes a full-fledged professional project.

Suggestion changes for CONTRIBUTING.md file:

For development, let's use a "dev" branch
For production, let's use a 'prod' or 'live' branch (master is also fine)
Contributors will send their pull-requests to development branch. After review, PR will be merged in development branch of this repo. We can have a deployment date set so that code changes (commits) from development branch will be merged with the production branch
We can deploy the app (development branch) to Heroku or Netlify so people can see how the app looks
Setup separate configuration keys (if any) for development and branch

Thoughts?

Suggestion changes for README.md file:

Update title
Remove the default content generated by Angular CLI
Describe the project (partial content from SPEC.md file)
If we are deploying the app (development branch) to Heroku or Netlify, then use their badges to show current status of the app

Thoughts?

Suggestion changes for SPEC.md file:

Mention tools and utilities used in the project (Front-end, Back-end, DB, etc.)
Update the content for "Team" section
Add content for Login / Registration flow
Add content for the entire app flow

Thoughts?

Other suggestions:

Setup a GitHub page (gh-pages branch) and develop a landing page to describe details and features of the app
It can have a "Contributors" menu/section to show who all contributed to this repo
Maintain contributors details (GitHub username, etc.) in a JSON file and read data from it to show in the contributors section

Thoughts?

maaxow commented 4 years ago

Thanks for all suggestions, I appreciate your motivation for the project, and I like to work with you.

I (re)read that later, and i do some change as you go. Sorry i'm not really active on the project, but I have some work for my company, so i can help you every day 😄

NitinNair89 commented 4 years ago

Ok, no issues. Let's use the hacktoberfest to get this project to completion. 😉

maaxow / BringBreakfast

Document updates #11