├── .github └── ISSUE_TEMPLATE │ ├── bug-report.md │ └── feature-request.md ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── README.md └── assets └── logo.png /.github/ISSUE_TEMPLATE/bug-report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug Report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: bug 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Versions** 11 | *Please fill in all that apply:* 12 | - Convergence Version: [e.g. 1.0.0] 13 | - OS: [e.g. Linux, MacOS] 14 | - Browser: [e.g. chrome, safari] 15 | - Java Version: [e.g. openjdk 11] 16 | 17 | **Describe the Bug** 18 | A clear and concise description of what the bug is. 19 | 20 | **Step To Reproduce** 21 | *A code snippet or gist to reproduce the issue will greatly improve our response time* 22 | 1. steps 23 | 24 | **Expected Behavior** 25 | A clear and concise description of what you expected to happen. 26 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature-request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature Request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: enhancement 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Versions** 11 | *Please fill in all that apply:* 12 | - Convergence Version: [e.g. 1.0.0] 13 | - OS: [e.g. Linux, MacOS] 14 | - Browser: [e.g. chrome, safari] 15 | - Java Version: [e.g. openjdk 11] 16 | 17 | **Description** 18 | A clear and concise description of the feature you would like. 19 | 20 | **Is there a workaround in the absence of this feature?** 21 | A clear and concise description of any alternative solutions or features you've considered. 22 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, sex characteristics, gender identity and expression, 9 | level of experience, education, socio-economic status, nationality, personal 10 | appearance, race, religion, or sexual identity and orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | * Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting the project team at info@convergencelabs.com. All 59 | complaints will be reviewed and investigated and will result in a response that 60 | is deemed necessary and appropriate to the circumstances. The project team is 61 | obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 71 | available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html 72 | 73 | [homepage]: https://www.contributor-covenant.org 74 | 75 | For answers to common questions about this code of conduct, see 76 | https://www.contributor-covenant.org/faq 77 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to the Convergence JavaScript Client 2 | 3 | First, thanks for your interests in contributing to Convergence. We strive to build a strong and open community focused on making Convergence the best real time collaboration framework. 4 | 5 | Here are some important resources: 6 | * [Convergence Community Forum](https://forum.convergence.io) ask questions or tell us what your working on! 7 | * [The Convergence Road Map](https://convergence.io/roadmap) provides a high-level view of where we are headed. 8 | * [The Convergence Project](https://github.com/convergencelabs/convergence-project) is the centralized project for issue reporting. 9 | 10 | # Issues 11 | Please submit all issues, bugs, feature requests etc. to this project. However, please do not ask questions in issues. 12 | 13 | Thanks, 14 | Convergence Labs, Inc. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |