[go: nahoru, domu]

Skip to content

Latest commit

 

History

History
64 lines (40 loc) · 2.35 KB

CONTRIBUTING.md

File metadata and controls

64 lines (40 loc) · 2.35 KB

Contributing to NumToWordsGo Thank you for considering contributing to NumToWordsGo! We appreciate your interest in improving our project. To ensure a smooth collaboration, please review the following guidelines before submitting your contributions.

Types of Contributions We welcome the following types of contributions:

Bug reports: If you encounter any bugs or issues, please submit a detailed bug report. Include the steps to reproduce the problem and any relevant information that can help us understand and resolve it.

Feature requests: If you have a suggestion for a new feature or enhancement, please submit a feature request. Describe the proposed feature, its benefits, and any implementation ideas you might have.

Code contributions: If you want to contribute code to the project, please follow our code contribution process outlined below.

Code Contribution Process Fork the repository on GitHub.

Clone the forked repository to your local machine.

git clone git@github.com:yousifnimah/NumToWordsGo.git

Create a branch for your changes.

git checkout -b my-branch

Make your changes to the codebase.

Test your changes to ensure they work as expected.

Commit your changes with a descriptive commit message.

git commit -m "Add new feature: description of the changes"

Push your branch to your forked repository.

git push origin my-branch

Open a pull request against the main repository. Clearly describe your changes, why they are needed, and provide any additional information that would be helpful for the review process.

Participate in the code review process, addressing any feedback or suggestions.

Once your pull request is approved, it will be merged into the main repository.

Code Style and Guidelines Follow the existing code style and conventions used in the project.

Write clear, concise, and meaningful commit messages.

Include appropriate documentation for new features or changes.

Write unit tests whenever possible to maintain and improve code quality.

Communication For general discussions or questions, please use the GitHub issue tracker.

Code of Conduct Please note that by contributing to this project, you agree to abide by our Code of Conduct. We expect all contributors to maintain a respectful and inclusive environment for everyone involved.

We appreciate your time and effort in contributing to our project. Happy coding!