Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added Basic Contact Manager to Beginner Projects (#471)
## Pull Request for PyVerse 💡 ### Requesting to submit a pull request to the PyVerse repository. --- #### Issue Title **Please enter the title of the issue related to your pull request.** Add Basic Contact Manager to Beginner Projects - [✅ ] I have provided the issue title. --- #### Info about the Related Issue **What's the goal of the project?** The aim of the Contact Manager project is to create a simple command-line application that allows users to efficiently manage their contacts. The key objectives include: Contact Management: Enable users to add new contacts with a name and phone number, view existing contacts, and delete contacts as needed. User-Friendly Interface: Provide a straightforward command-line interface that allows users to navigate through options easily. Data Handling: Implement basic data handling to store and retrieve contact information within the application's session. Educational Tool: Serve as an educational resource for those learning Python, demonstrating concepts like object-oriented programming, user input handling, and basic data structures. Overall, the project aims to simplify contact management for users while offering a hands-on programming experience. - [✅] I have described the aim of the project. --- #### Name **Please mention your name.** Adwitya Chakraborty - [✅] I have provided my name. --- #### GitHub ID **Please mention your GitHub ID.** adwityac - [✅] I have provided my GitHub ID. --- #### Email ID **Please mention your email ID for further communication.** adwityachakraborty@hotmail.com - [✅] I have provided my email ID. --- #### Identify Yourself **Mention in which program you are contributing (e.g., WoB, GSSOC, SSOC, SWOC).** Contributor (GSSOC) - [✅] I have mentioned my participant role. --- #### Closes **Enter the issue number that will be closed through this PR.** *Closes: #465 * - [✅] I have provided the issue number. --- #### Describe the Add-ons or Changes You've Made **Give a clear description of what you have added or modified.** In the Contact Manager project, I've added detailed comments throughout the code to clarify its functionality and improve readability. These comments explain the purpose of each class and method, guiding users through the code structure and flow. Additionally, I included a sample interaction section at the end of the code, demonstrating how the application works in practice. This section outlines user inputs and the corresponding outputs, making it easier for users to understand how to interact with the program effectively. Overall, these modifications enhance the educational value of the project by providing context and examples for users. - [✅] I have described my changes. --- #### Type of Change **Select the type of change:** - [ ] Bug fix (non-breaking change which fixes an issue) - [✅] New feature (non-breaking change which adds functionality) - [ ] Code style update (formatting, local variables) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] This change requires a documentation update --- #### How Has This Been Tested? **Describe how your changes have been tested.** The changes have been tested by running the contact manager in various scenarios to ensure all functionalities work as intended. I verified that users can successfully add contacts, view the list of contacts, and delete existing contacts. Each operation was tested with valid inputs, and I also checked how the program responds to invalid inputs, such as attempting to delete a non-existent contact. The sample interaction comments were validated against the actual outputs to confirm that they accurately represent the user experience. This comprehensive testing process ensured that the code functions correctly and provides a seamless user experience. - [✅] I have described my testing process. --- #### Checklist **Please confirm the following:** - [✅] My code follows the guidelines of this project. - [✅] I have performed a self-review of my own code. - [✅] I have commented my code, particularly wherever it was hard to understand. - [✅] I have made corresponding changes to the documentation. - [✅] My changes generate no new warnings. - [✅] I have added things that prove my fix is effective or that my feature works. - [✅] Any dependent changes have been merged and published in downstream modules.
- Loading branch information