Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/CommunityKit/yack-connector-framework. This project and the corresponding Yack Feedback community #developers channel is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
Submitting Issues
The issue list in the yack-connector-framework should be reserved for bug reports and feature requests related to this framework. Usage questions should be submitted in the #developers channel in the Yack Feedback Discourse forum in-app. As a general rule of thumb, use the appropriate issue labels in Github to categorize the issue before submitting. If you open an issue that’s actually a usage or implementation question we may redirect the conversation to the #developers channel in the Yack Feedback forum.
Usage and Implementation Resources
- Read the yack-connector-framework docs
- Review related comments in the yack-template-connector repo
- Search for related questions or issues in the #developers community
- Ask for help on the #developers channel forum in-app
UI Extensibility
Sometimes the network community that you’re building a Yack Connector for features alternative types of Reactions or other UI specific icons or uniquely distinct user experiences that don’t quite fit into the Yack experience, please submit an issue for our review labeled UI detailing why these UI changes require support and should be added to the Yack interface. If we find the proposal significant in improving the Yack experience we may submit it to the Yack Feedback community for input and voting, then add to the product roadmap. While not all Connector sources’ experiences fit perfectly within the Yack experience, we have found that community brainstorming sometimes helps mapping these features to the existing UI.
Usage
Do
- Make things easier on yourself and start by cloning the yack-template-connector repo.
- Use small commits and commit often with meaningful commit messages as to improve code collaboration.
- Use official APIs if there are any available, or else implement transformers to transform HTML into Yack objects.
Don’t
- Send any data to external sources, including analytics, that are not the core network source you’re building your Yack Connector around. Any Connector developers that have attempted to add in external data sources beyond the scope of the network Connector that is being built upon will automatically be ineligible to publish to the Yack Connector Marketplace.
- Forget to remove all comments or logs that may contain confidential cookie, authentication, or user data.