Skip to content

Latest commit

 

History

History
48 lines (30 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

48 lines (30 loc) · 2.3 KB

Contributing to [Project Name]

Welcome to [Project Name]! We are thrilled to have you here. Thank you for your interest in contributing to our project. Together, we can make this project even better.

Code of Conduct

Before you start contributing, please familiarize yourself with our Code of Conduct. We expect all contributors to adhere to this code to maintain a friendly and inclusive community.

How to Contribute

We appreciate contributions in various forms, including bug reports, feature requests, documentation improvements, and code contributions. Here's a quick guide on how you can contribute:

  1. Fork the repository on GitHub.
  2. Create a new branch from the main branch for your changes.
  3. Make your desired changes, ensuring that they align with the project's guidelines and coding standards.
  4. Test your changes thoroughly to avoid introducing new issues.
  5. Commit your changes with clear and descriptive commit messages.
  6. Push your changes to your forked repository.
  7. Submit a pull request to the main branch of the original repository.

Bug Reports and Feature Requests

If you encounter a bug or have a feature request, please open an issue on GitHub. Make sure to provide sufficient details to help us understand the problem or your proposed enhancement better.

Code Contribution

When making code contributions, please keep the following in mind:

  • Follow the coding style and conventions used in the project.
  • Write clear and concise code with meaningful comments when necessary.
  • Include relevant test cases to validate your changes.

Pull Request Guidelines

To ensure a smooth review process, please adhere to the following guidelines when submitting a pull request:

  • Provide a clear and descriptive title for your pull request.
  • Include a detailed description of the changes you've made and their purpose.
  • Reference any related issues in your pull request description using the #issue_number format.
  • Ensure that all tests pass successfully before submitting your pull request.

Acknowledgments

We appreciate your valuable contributions, and to show our gratitude, all contributors will be acknowledged in the project's README.

Thank you for being part of MoneyPenny AI Prompt! Together, let's make coding a better experience for everyone.

Happy hacking!