Skip to content

Commit

Permalink
Update CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
MrAlias committed Jun 17, 2021
1 parent 319d9ce commit c5b5ae6
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion CONTRIBUTING.md
Expand Up @@ -380,14 +380,23 @@ func NewDog(name string, o ...DogOption) Dog {…}
func NewBird(name string, o ...BirdOption) Bird {…}
```

### Interface Type
### Interfaces

To allow other developers to better comprehend the code, it is important
to ensure it is sufficiently documented. One simple measure that contributes
to this aim is self-documenting by naming method parameters. Therefore,
where appropriate, methods of every exported interface type should have
their parameters appropriately named.

#### Interface Stability

All exported stable interfaces that include the following warning in their
doumentation are allowed to be extended with additional methods.

> Warning: methods may be added to this interface in minor releases.
Otherwise, stable interfaces MUST NOT be modified.

## Approvers and Maintainers

Approvers:
Expand Down

0 comments on commit c5b5ae6

Please sign in to comment.