Skip to content

Latest commit

 

History

History
64 lines (42 loc) · 2.81 KB

CONTRIBUTING.md

File metadata and controls

64 lines (42 loc) · 2.81 KB

🤝 Contributing to Spendify

We welcome your contributions to the Spendify project! Whether you're a developer, designer, or enthusiast, your help is essential in making Spendify even better. Please take a moment to review this guide for contributing.

💡 How to Contribute

  1. Fork the Spendify repository on GitHub.
  2. Create a branch from the main branch for your work.
  3. Make your changes or improvements.
  4. Ensure your code follows the project's coding standards.
  5. Test your changes to make sure they work as expected.
  6. Commit your changes with clear and concise messages.
  7. Push your branch to your fork.
  8. Submit a pull request to the main repository.

📄 Reporting Issues

If you encounter any issues or have suggestions, please use the issue tracker on GitHub. Be sure to include the following details:

  • A clear and descriptive title.
  • Steps to reproduce the issue or a clear explanation of your suggestion.
  • Expected and actual behavior.
  • Screenshots or code examples if applicable.

🌟 Coding Standards

To maintain code consistency, we have the following guidelines:

  • Follow the project's established code style.
  • Write clear, concise, and informative code and comments.
  • Ensure your code is properly formatted.

💬 Code Reviews

All code contributions will undergo review before they are merged. Reviewers may provide feedback or request changes to your code. Please address any comments or suggestions promptly.

📝 Documentation

Improvements to documentation are always appreciated. If you find any discrepancies or wish to enhance the documentation, feel free to make your changes.

📌 Issue Labels

We use labels to categorize and prioritize issues. Here's what the labels mean:

  • Bug: Indicates a bug in the code.
  • Feature Request: Suggesting a new feature.
  • Documentation: Changes or improvements to documentation.
  • Enhancement: Enhancements to existing features.
  • Help Wanted: We need help from the community.
  • Good First Issue: Issues that are ideal for new contributors.

🔒 Code of Conduct

Please adhere to our Code of Conduct in all interactions within the project.

📦 Dependencies

If your contribution involves adding new dependencies or updating existing ones, please provide a clear explanation for the changes. Dependencies should be kept up-to-date and well-documented.

🎉 Thanks for Contributing

Your contributions are essential to the growth and success of Spendify. We appreciate your efforts in helping us create a better financial management tool for everyone.

Please ensure that your contributions are in line with our Code of Conduct.

If you have any questions or need assistance, feel free to reach out to the project maintainers. Happy coding!