Skip to content

Latest commit

 

History

History
38 lines (28 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

38 lines (28 loc) · 1.88 KB

Contributing to SalesSparrow Project

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

If you would like to contribute code to Sales Sparrow, please follow these steps:

  1. Fork the GitHub repository to your own GitHub account.
  2. Create a new branch with a descriptive name for your changes.
  3. Make your code changes and ensure that they adhere to our coding guidelines.
  4. Test your changes thoroughly to ensure they work as expected.
  5. Commit your changes and push them to your forked repository.
  6. Open a pull request from your branch to the main Sales Sparrow repository.
  7. Wait for our team to review your pull request and provide feedback.
  8. Once your pull request is approved, your changes will be merged into the main repository.

Coding Guidelines

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

  • 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 Sales Sparrow! 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!