Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 2.74 KB

CONTRIBUTING.md

File metadata and controls

48 lines (33 loc) · 2.74 KB
Raw

Contributing Guidelines

Thank you for considering contributing to our WebexCC API Samples project! We welcome contributions from the community to help improve our API usage samples for Webex Contact Center. By contributing, you can help others understand and effectively utilize our API.

To ensure a smooth collaboration process, please follow these guidelines when contributing to the project:

Code of Conduct

Please review and adhere to our Code of Conduct throughout your participation in the project.

How to Contribute

  1. Fork the repository to your GitHub account.
  2. Create a new branch for your contribution: git checkout -b feature/your-feature-name.
  3. Make your changes and ensure they are well-documented, maintainable, and adhere to our coding standards.
  4. Test your changes thoroughly to ensure they work as intended.
  5. Commit your changes with a clear and descriptive commit message: git commit -m "Add your commit message here".
  6. Push your changes to your forked repository: git push origin feature/your-feature-name.
  7. Submit a pull request (PR) from your branch to the main branch of the main repository.
  8. Provide a detailed description of your changes in the pull request, including the problem you are solving or the feature you are adding.
  9. Be responsive to any feedback or suggestions provided during the review process.
  10. Once your changes have been reviewed and approved, they will be merged into the main repository.

Contribution Ideas

  • Add new Webex Contact Center API usage samples to demonstrate specific functionalities or use cases.
  • Improve the existing WebexCC API samples by making them more clear, concise, or efficient.
  • Add more variants to the sample code available. We have a limited set of samples based on capacity and availability of our contributors.
  • Fix any issues or bugs found in the samples.
  • Update the samples to align with the latest version of the API found at : https://developer.webex-cx.com/.

Coding Guidelines

  • Follow the existing code style and conventions used in the project.
  • Maintain consistency with the existing samples in terms of naming, structure, and documentation.
  • Use meaningful variable and function names that accurately represent their purpose.
  • Include inline comments to explain complex logic or provide additional context.

Testing

  • Ensure that your code changes do not break any existing samples.
  • Write unit tests or integration tests when applicable to verify the correctness of your code.

License

By contributing to this project, you agree that your contributions will be licensed under the same license as the project.

We appreciate your contribution to our Webex Contact Center API usage samples. Thank you for your support!