Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Flow to work on this repo #39

Open
Naveen-g09 opened this issue Apr 1, 2024 · 0 comments
Open

Flow to work on this repo #39

Naveen-g09 opened this issue Apr 1, 2024 · 0 comments
Assignees

Comments

@Naveen-g09
Copy link
Owner

Welcome to Residentron Frontend Repository

Introduction

Welcome to Residentron's frontend repository! This is where we develop the frontend application using Expo React Native. Before contributing, it's essential to have a strong foundation in Git, GitHub, TypeScript, React basics, CSS fundamentals, and know how to set up your development environment.

Getting Started

  1. Clone/Fork the Repository: Begin by cloning or forking this repository to your local machine. This allows you to have a copy of the project on your system to work on.

  2. Create Your Branch: Once you have the repository cloned, create your own branch to work on your contributions. Branches help keep your changes separate from the main codebase until they're ready to be merged.

  3. Publish Branch: After making changes, push your branch to the repository and give it a descriptive title indicating what you're solving or adding. This helps in tracking changes and understanding the purpose of each branch.

  4. Create a Pull Request: Submit a pull request to the main repository. Pull requests are used to propose changes and request that someone review and approve them before merging into the main codebase.

  5. Request a Review: After creating the pull request, request a review from the team. Reviews ensure that code changes meet the project's standards and requirements.

  6. Commit Frequently: Try to commit often and keep your commit messages neat and descriptive. This helps in tracking changes and understanding the evolution of the codebase over time.

Tips and Tricks

  • Package.json Scripts: Familiarize yourself with the scripts in package.json to understand how the app runs. Pay attention to the pre-commit script, which handles lint fixes, formatting, etc., ensuring code quality.
  • Visual Studio Code Setup: Set up Visual Studio Code and an emulator for easy development. Follow the documentation here to ensure a smooth development experience.
  • Use Yarn: We use Yarn as our package manager. Make sure to have it installed initially to manage project dependencies efficiently.
  • Environment Variables: Understand how environment variables work as they are crucial for configuring the application's behavior based on the environment.
  • Folder Structure and Best Practices: Follow the folder structure and best practices outlined in the project to maintain consistency and make collaboration easier.
  • React and TypeScript: Have a good understanding of TypeScript and React basics, including how hooks work and how props are passed between components.
  • CSS Basics: Understand the CSS box model and basics of CSS to style components effectively and enhance the visual appeal of the application.
  • Local Projects: Creating a few local projects can help you understand the app-building process and how they compile. This knowledge can significantly speed up the development process for this project.

Contributing Guidelines

  • Ensure your branch is updated with the main development branch before creating a pull request to avoid conflicts.
  • Keep pull requests focused on a single feature or issue to simplify the review process and facilitate collaboration.
  • Maintain clean and descriptive commit messages to provide clarity on the changes made.
  • Make sure all checks are passing, and GitHub builds are successful before submitting a pull request to ensure the stability of the codebase.

Conclusion

Thank you for considering contributing to Residentron's frontend repository! We highly appreciate your contributions and look forward to collaborating with you. If you have any questions or need assistance at any step of the process, feel free to reach out to us. Happy coding!


@2905Abhishek @sanyuktaj10
hoping a humble contribution! Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants