Skip to content

Latest commit

 

History

History
40 lines (22 loc) · 2.98 KB

CONTRIBUTING.md

File metadata and controls

40 lines (22 loc) · 2.98 KB
Raw

Contributing to SalesSparrow

We welcome contributions to salessparrow from the community! Whether you want to report a bug, suggest an enhancement, or submit a code change, your help is greatly appreciated.

Bug Reports and Feature Requests

If you find a bug or have a feature request, please open an issue on our GitHub repository. Be sure to include as much detail as possible so we can better understand and address the issue or request.

Code Contributions and Test-Driven Development

If you're interested in contributing code to the salessparrow project, we encourage you to follow these steps:

  1. Fork the Repository: Start by forking the GitHub repository to your own GitHub account. This creates a copy of the project that you can freely work on.

  2. Create a Descriptive Branch: Next, create a new branch in your forked repository. Give it a descriptive name that reflects the changes you plan to make.

  3. Adhere to Coding Guidelines: Before making any changes, ensure that your code follows our coding guidelines. Consistent coding styles help maintain the project's overall quality and readability.

  4. Test Your Changes: It's crucial to thoroughly test your code changes. Provide both unit tests and UI unit tests that cover the new feature, improvement, or fix you're introducing.

  5. Commit and Push: Once you're confident in your changes and have tested them, commit the code to your branch and push it to your forked repository.

  6. Open a Pull Request: Open a pull request from your branch to the main salessparrow repository. Describe the changes you've made, and the reasons behind them.

  7. Review and Feedback: Our team will review your pull request promptly. We'll provide constructive feedback and suggestions if needed to help improve your contribution.

  8. Merge into Main Repository: After your pull request is approved and meets all the necessary requirements, we'll merge your changes into the main salessparrow repository. Congratulations on your successful contribution!

By adhering to these steps and incorporating test-driven development, you help maintain the project's stability and ensure the reliability of new code additions. Thank you for your valuable contributions to the salessparrow project!

Coding Guidelines

To maintain code consistency and readability, please follow these coding guidelines when contributing to salessparrow:

  • Use descriptive names for variables, functions, and classes.
  • Write clear and concise comments to explain your code.
  • Follow the standard indentation and formatting used in the existing codebase.
  • Avoid unnecessary code duplication and use helper functions where appropriate.

Thank you for contributing to salessparrow project! Your help is invaluable in making this project better for everyone in the community. If you have any questions or need assistance, please don't hesitate to reach out to us. Happy coding!