From 78a302f0bc4317f9da353576fc724dfcde80714d Mon Sep 17 00:00:00 2001 From: Boateng Prince Agyenim <163312213+Mmabiaa@users.noreply.github.com> Date: Sat, 18 Jan 2025 13:13:01 +0000 Subject: [PATCH 1/4] Create Contribution.md --- Contribution.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 Contribution.md diff --git a/Contribution.md b/Contribution.md new file mode 100644 index 0000000..d562903 --- /dev/null +++ b/Contribution.md @@ -0,0 +1,44 @@ +# Contributing to calculator_ + +Thank you for considering contributing to the mmabiaa/calculator_ project! We welcome contributions from everyone, whether it's code, documentation, or feedback. + +## How to Contribute + +### Reporting Issues +If you encounter bugs or have suggestions for improvements, please open an issue in the GitHub repository. Make sure to provide as much detail as possible, including steps to reproduce the issue. + +### Submitting Code Changes +1. **Fork the Repository**: Click the "Fork" button at the top right of the repository page to create your own copy of the project. + +2. **Clone Your Fork**: Clone your forked repository to your local machine: +git clone https://github.com/mmabiaa/calculator_.git + +3. **Create a Branch**: Create a new branch for your feature or bug fix: +git checkout -b feature/your-feature-name + +4. **Make Changes**: Implement your changes. Ensure that your code adheres to the existing style and conventions used in the project. + +5. **Test Your Changes**: Run the application and ensure that everything works as expected. If applicable, add tests for any new features. + +6. **Commit Your Changes**: Commit your changes with a clear and concise commit message: +git commit -m “Add feature: description of feature” + +7. **Push Your Changes**: Push your changes to your forked repository: +git push origin feature/your-feature-name + +8. **Create a Pull Request**: Go to the original repository and click on "New Pull Request." Select your branch and submit the pull request. Provide a detailed description of your changes. + +### Code Style Guidelines +- Follow PEP 8 guidelines for Python code. +- Use meaningful variable and function names. +- Write comments where necessary to explain complex logic. + +### Documentation +If you make changes that affect how users interact with the calculator, please update the documentation accordingly. This includes updating README files or adding comments in the code. + +## Getting Help +If you have questions or need assistance, feel free to reach out by opening an issue or contacting maintainers directly through GitHub. + +## Thank You! +We appreciate your interest in contributing to mmabiaa/calculator_. Together, we can make this project even better! + From 679ce426943ec5a9acbcad3a352e70710ebb4e17 Mon Sep 17 00:00:00 2001 From: Boateng Prince Agyenim <163312213+Mmabiaa@users.noreply.github.com> Date: Sat, 18 Jan 2025 13:14:45 +0000 Subject: [PATCH 2/4] Create Code_of_conduct.md --- Code_of_conduct.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 Code_of_conduct.md diff --git a/Code_of_conduct.md b/Code_of_conduct.md new file mode 100644 index 0000000..785e15e --- /dev/null +++ b/Code_of_conduct.md @@ -0,0 +1,35 @@ +# Code of Conduct + +## Our Commitment + +As contributors and maintainers of this project, we pledge to foster an open and welcoming community. We are committed to making participation a harassment-free experience for everyone, regardless of experience level, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality. + +## Our Standards + +Examples of behavior that contributes to a positive environment include: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +## Unacceptable Behavior + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery and unwelcome sexual attention or advances +- Trolling, insulting/derogatory comments, and personal attacks +- Public or private harassment +- Publishing others' private information without explicit permission +- Other conduct which could reasonably be considered inappropriate in a professional setting + +## Reporting Issues + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainers. All complaints will be reviewed and investigated promptly and fairly. Maintainers are obligated to maintain confidentiality regarding the reporter of an incident. + +## Enforcement + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that do not align with this Code of Conduct. They may also ban temporarily or permanently any contributor for behaviors deemed inappropriate. + +By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to all aspects of managing this project. From 111947d55eb92e5ade31bb6ca75dd7da606fc5b6 Mon Sep 17 00:00:00 2001 From: Boateng Prince Agyenim <163312213+Mmabiaa@users.noreply.github.com> Date: Sat, 18 Jan 2025 13:17:26 +0000 Subject: [PATCH 3/4] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 639ad07..98c2975 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ Once the application is running, you can perform calculations by clicking the bu ## Contributing -We welcome contributions! To contribute to this project: +We welcome contributions! To contribute to this project, please follow these steps or [view CONTRIBUTION FILE](Contribution.md): 1. Fork the repository. 2. Create a new branch (`git checkout -b feature/YourFeature`). @@ -65,6 +65,7 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file - Thank you to the contributors and users who help improve this project. - Inspired by various open-source calculator projects. +- [View Code of Conduct](Code_of_conduct) --- From 27b8e4444a384cefd0eee84d35f48b7f6f578fec Mon Sep 17 00:00:00 2001 From: Boateng Prince Agyenim <163312213+Mmabiaa@users.noreply.github.com> Date: Sat, 18 Jan 2025 13:20:14 +0000 Subject: [PATCH 4/4] Update Contribution.md --- Contribution.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/Contribution.md b/Contribution.md index d562903..fbfaab9 100644 --- a/Contribution.md +++ b/Contribution.md @@ -11,22 +11,27 @@ If you encounter bugs or have suggestions for improvements, please open an issue 1. **Fork the Repository**: Click the "Fork" button at the top right of the repository page to create your own copy of the project. 2. **Clone Your Fork**: Clone your forked repository to your local machine: +```bash git clone https://github.com/mmabiaa/calculator_.git - +``` 3. **Create a Branch**: Create a new branch for your feature or bug fix: +``` git checkout -b feature/your-feature-name - +``` 4. **Make Changes**: Implement your changes. Ensure that your code adheres to the existing style and conventions used in the project. 5. **Test Your Changes**: Run the application and ensure that everything works as expected. If applicable, add tests for any new features. 6. **Commit Your Changes**: Commit your changes with a clear and concise commit message: +``` git commit -m “Add feature: description of feature” +``` 7. **Push Your Changes**: Push your changes to your forked repository: +``` git push origin feature/your-feature-name - -8. **Create a Pull Request**: Go to the original repository and click on "New Pull Request." Select your branch and submit the pull request. Provide a detailed description of your changes. +``` +9. **Create a Pull Request**: Go to the original repository and click on "New Pull Request." Select your branch and submit the pull request. Provide a detailed description of your changes. ### Code Style Guidelines - Follow PEP 8 guidelines for Python code.