-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #15 from Mmabiaa/Update-Branch
Enhanced Documentation
- Loading branch information
Showing
3 changed files
with
86 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
# 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: | ||
```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 | ||
``` | ||
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. | ||
- 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! | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters