Skip to content
Navigation Menu
Sign in
Appearance settings
Platform
AI CODE CREATION
GitHub Copilot
Write better code with AI
GitHub Copilot app
Direct agents from issue to merge
MCP Registry
Integrate external tools
DEVELOPER WORKFLOWS
Actions
Automate any workflow
Codespaces
Instant dev environments
Issues
Plan and track work
Code Review
Manage code changes
Code Quality
Enforce quality at merge
APPLICATION SECURITY
GitHub Advanced Security
Find and fix vulnerabilities
Code security
Secure your code as you build
Secret protection
Stop leaks before they start
EXPLORE
Why GitHub
Documentation
Blog
Changelog
Marketplace
View all features
Solutions
BY COMPANY SIZE
Enterprises
Small and medium teams
Startups
Nonprofits
BY USE CASE
App Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRY
Healthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
Resources
EXPLORE BY TOPIC
AI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPE
Customer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICES
Documentation
Customer support
Community forum
Trust center
Partners
View all resources
Open Source
COMMUNITY
GitHub Sponsors
Fund open source developers
PROGRAMS
Security Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIES
Topics
Trending
Collections
Enterprise
ENTERPRISE SOLUTIONS
Enterprise platform
AI-powered developer platform
AVAILABLE ADD-ONS
GitHub Advanced Security
Enterprise-grade security features
Copilot for Business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
nyarly
sockjs-ruby
Repository navigation
Code
Issues
8
(8)
Pull requests
1
(1)
Actions
Projects
Wiki
Security and quality
Insights
More
items
Files
Expand file tree
master
Breadcrumbs
sockjs-ruby
/
contributing
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
37 lines (25 loc) · 1.21 KB
master
Breadcrumbs
sockjs-ruby
/
contributing
Copy path
Top
File metadata and controls
Code
Blame
37 lines (25 loc) · 1.21 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# CONTRIBUTING
The SockJS protocol has stablized somewhat, but this project isn't my only
work, and I'd really appreciate any and all contributions. If you're looking
for places to get started, check out the Issues list. Heck: additions to Issues
are a good place to get started.
Along those lines: please feel free to file an Issue before starting work on a
fork - we're all busy, and I'd hate for you to waste your time on something
that won't get merged.
# GIT RELATED
Fork, hack, pull-request. Nothing fancy. If contribution explodes I may
reconsider this policy.
I personally prefer merge over rebase, but I'm not going to reject your
beautiful lie of a local revision history, if that's what you want to do.
# TESTING
Please do add tests for your changes. I will almost certainly reject PRs
without decent testing.
# ARCHITECTURE
Because of the nature of the project, it's very easy for the code to get
spaghettified. Sessions (and a couple of the protocol handlers) are built on an
State Machine pattern, and code that doesn't align with that will not get
merged. Basically, if you're tempted to use a conditional based on the state of
a connection, *don't.*
# BOUNDARIES
Do not:
* edit the gemspec or the version.rb
You can’t perform that action at this time.