Update outdated contributing guidelines, specially the local setup and monorepo migration documentation

[sidd190]

This PR updates the contributing guidelines for setting up the codebase locally and other outdated versions and commands mentioned.

No issue is open for this.

[gemini-code-assist]

Summary of Changes

Hello @sidd190, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly updates the CONTRIBUTING.md file to reflect the current development environment and tooling. The changes aim to provide accurate and up-to-date guidelines for setting up the codebase locally, managing dependencies with pnpm, utilizing nx for project commands, and deploying to various environments. This ensures that new and existing contributors have clear, functional instructions for contributing to the project.

Highlights

• Node.js Version Update: The required Node.js version for local development has been updated from 16 to 20, along with instructions to use nvm install 20 and nvm use 20.
• New Global Tools Installation: Instructions have been added to install global tools including firebase-tools, nx, and pnpm using npm install -g.
• Streamlined Local Development Workflow: The local development setup has been revised, replacing npm run start:local with pnpm install for dependencies and nx start to build and run the local Firebase Emulator and Angular dev server.
• Updated Local Access URLs: The local app URL is now consistently http://localhost:4200, and the Firebase Emulator UI remains at http://localhost:4000.
• Revised Data Export Command: The command to persist changes to the demo data snapshot has been updated from npm run export:local to nx export.
• New Deployment and Staging Instructions: The section for 'Using live Firebase' has been replaced with detailed instructions for running against a live staging environment (nx run web:serve:staging), deploying to staging (npx firebase login and nx run deploy:staging), and deploying to a production Firebase project (nx run deploy:production).
• Git Branching Command Correction: The example command for creating a new git branch has been corrected from git checkout -d to git checkout -b.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

The pull request updates the contributing guidelines, focusing on local setup and monorepo migration documentation. The changes include updating Node.js versions, global tool installations, and commands for running and deploying the application. The documentation is now more current and accurate, which will greatly assist new and existing contributors.

[gino-m]

Most content in this file is a duplicate of what's in README.md. Can we please remove that content and refer to README.md instead?

[sidd190]

Most content in this file is a duplicate of what's in README.md. Can we please remove that content and refer to README.md instead?

Like do i just remove the content and keep only the headers and mention to refer to the readme for setting the codebase up locally, for example?

[gino-m]

Most content in this file is a duplicate of what's in README.md. Can we please remove that content and refer to README.md instead?

Like do i just remove the content and keep only the headers and mention to refer to the readme for setting the codebase up locally, for example?

You can replace lines 67-130 in the original file with a reference to README.md, e.g,:

## Development

See (link to README.md) for instructions how to build, run, and test locally.

[sidd190]

You can replace lines 67-130 in the original file with a reference to README.md

Donee! Sorry I got stuck with uni assignments a bit.

[gino-m]

Nicely done, thanks for the fix!