Skip to content

Latest commit

 

History

History
75 lines (58 loc) · 4.8 KB

CONTRIBUTING.md

File metadata and controls

75 lines (58 loc) · 4.8 KB

Contributing to Pong

Table of contributor-covenant

Code of Conduct

How can I Contribute ?

Code of Conduct

This project, and everyone participating in it is governed by the Pong Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected]

How can I contribute ?

Reporting Bugs

This section guides you through submitting a bug report for Pong. Following these guideline helps maintainers and the community understanding your report, reproduce the behavior and find related reports.

Before creating a bug reports, check all issues to check the presence of your bug. If you don't find the bug on issues, you must create a new bug report include as many details as possible.

Note : If you find a Closed issue that seems like it's the same things that you're experiencing, open a new issue and include a link to the original issue in the body of the new one.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Pong, including new features and minor improvements on existing functionality. Following these guideline helps maintainers and the community understanding your suggestion and find related suggestions.

Before creating enhancement suggestions, please check all issues as you might find out that you don't need to create one. When you're creating an enhancement suggestion, please include as many details as possible.

Styleguide

Commit Message

  • Use the present tence ("Add feature" instead of "Added feature")
  • Use the imperative mood ("Move cursor to ..." instead of "Moves cursor to ...")
  • Limit the first line to 72 characters or less.
  • Short description must begin by a capitalize character ("Add feature." instead of "add feature.").
  • Reference issues and pull requests liberaly after the first line.
  • Consider starting the commit message with an applicable emoji.
Emoji Emoji code Description
📝 :pencil: When improving format/structure code.
🐎 :racehorse: When improving code performances.
📚 :books: When writting docs on source code.
:sparkles: When adding new features.
🐛 :bug: When fixing a bug
🔥 :fire: When removing features or file.
🚧 :construction: When commiting code on Work in Progress state.
🔧 :wrench: When updating settings or package manager file.
⬆️ :arrow_up: When upgrading dependencies.
⬇️ :arrow_down: When downgrading dependencies.
🔒 :lock: When dealing with security.
💄 :lipstick: When improving UI / Cosmetic.
:wheelchair: When improving accessibility.
🌐 :globe_with_meridians: When dealing with globalization / I18N / G11N.
🎉 :tada: Initial commit.
🔖 :bookmark: Version tags.
🏆 :trophy: New release.
🤝 :handshake: When merging files.