User:George: Difference between revisions

From Zenon Wiki
Jump to navigation Jump to search
Created page with "Contact me:"
 
Add maintainer guidelines
Line 1: Line 1:
Contact me:
'''Contact'''
 
matrix: @georgezgeorgez:hc1.chat
 
== Maintainer guidelines ==
 
=== go-zenon ===
 
==== Protocol Changes ====
 
# Do the changes follow an implementation neutral specification?
# Is there proof that a supermajority of validators want the change?
# Is the change well tested? (unit testing, functional and performance testing on testnets)
# Is the change accompanied by user facing documentation?
# Is there clear direction on upgrade/deprecation path? (spork vs hardfork vs etc)
 
==== Performance Changes ====
 
# Does the change meet one of the following:
## Improves average performance
## Improves situational performance AND does not worsen average performance
# Given that most performance considerations require trade-offs, it should not be necessary to prove that a performance change does not worsen situational performance
# Is there clear direction on upgrade/deprecation path? (data migrations vs resync vs etc)
 
===== Misc/QoL =====
 
# Is there clear direction on upgrade/deprecation path? (api lifecycle vs etc)

Revision as of 16:30, 27 November 2024

Contact

matrix: @georgezgeorgez:hc1.chat

Maintainer guidelines

go-zenon

Protocol Changes

  1. Do the changes follow an implementation neutral specification?
  2. Is there proof that a supermajority of validators want the change?
  3. Is the change well tested? (unit testing, functional and performance testing on testnets)
  4. Is the change accompanied by user facing documentation?
  5. Is there clear direction on upgrade/deprecation path? (spork vs hardfork vs etc)

Performance Changes

  1. Does the change meet one of the following:
    1. Improves average performance
    2. Improves situational performance AND does not worsen average performance
  2. Given that most performance considerations require trade-offs, it should not be necessary to prove that a performance change does not worsen situational performance
  3. Is there clear direction on upgrade/deprecation path? (data migrations vs resync vs etc)
Misc/QoL
  1. Is there clear direction on upgrade/deprecation path? (api lifecycle vs etc)