Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

33 lines (24 loc) · 1.19 KB

Contribute to @teteu/utils

I'd like to encourage you to contribute to the @teteu/utils repository. This should be as easy as possible for you but there are a few things to consider when contributing. The following guidelines for contribution should be followed if you want to submit a pull request or open an issue.


Quick Start

  • Code must strict adhere our Coding Guideline;
  • I greatly encourage you to write test cases for every method you may add;
  • You should always fork from the main branch;

Feature Requests

Feature and methods requests are always welcome. Just make sure to make your case to convince other developers to implement.


Pull Requests

The ideal format of Pull Requests is the following:
Scope of change:
Here you describe the impact of your changes to the project
Key File
changed_file.ts
Notes
This closes #{commit_number}...

Coding Guideline

  • We use camel_case to variable names;
  • We use double quotes for strings;
  • Every method must have a brief documentation above it;