Skip to content

Latest commit

 

History

History
81 lines (59 loc) · 3.19 KB

CONTRIBUTING.md

File metadata and controls

81 lines (59 loc) · 3.19 KB
Raw

Contributing

Thank you for your interest in Valva! I would love your input. You are very much welcomed to:

  • Report a bug
  • Discuss the current state of the code
  • Submit a fix
  • Propose new features
  • Suggest structural changes
  • Share tips
  • Extends this list

How To

For code contribution, please follow GitHub Workflow principles:

  • Fork the repo
  • Clone the project to your own machine
  • Commit changes to your own branch
  • Push your work back up to your fork
  • and submit a Pull request!

Style

Generalities

Please note that this project is usually written in a quite verbose manner; short syntax being avoided.
Any third party dependency addition must be strongly motivated.

And documentation of why-it-was-done-this-way, especially in the context of an odd case, is very much encouraged.

Commit Messages

Please try to start your commit messages with one or more of the following keywords:

  • wip: for work in progress
  • config: changes in yml/json config files for example
  • feature: functionnality additions
  • fix: bug fixes
  • test: tests
  • structure: files / folders reorg or renaming
  • style: code style edits, linting
  • opti: optimization / performance amelioration
  • docs: added doc or comment

Inline Comments

Please try to start your inline comments with one of the following tags:

  • @doc: for quick local code documentation
  • @todo: to indicate something that's not done yet, but will need to be

Naming things

If you wish to shorten the name of a file / class / method / function / variable / property / etc. : the general convention is to keep the first vowel, and then skip the rest of them. Example:

workreviews -> workrvws

But feel free to adapt this rule; main goal is a high code readability.

Code of Conduct

Contributing to this project must be a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

All participants thus pledge to act and interact in ways that insure an open, welcoming, diverse and inclusive environment.

Examples of expected behavior include:

  • Demonstrating empathy and kindness toward other people
  • Being respectful of differing opinions, viewpoints, and experiences
  • Giving and gracefully accepting constructive feedback
  • Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience

Examples of unacceptable behavior include:

  • The use of sexualized language or imagery, and sexual attention or advances of any kind
  • Trolling, insulting or derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others' private information, such as a physical or email address, without their explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting

Licensing

Valva is under MIT license.
Any included contribution shall be under the same license.