Skip to content
This repository has been archived by the owner on Oct 27, 2022. It is now read-only.

Latest commit

 

History

History
29 lines (19 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

29 lines (19 loc) · 1.73 KB
Raw

Contributing

We're happy if you wanted to help us developing this framework to it's peak! You could help us by creating new feature or maintain current code and fix current bug or etc.

Please keep in mind that we need to keep this framework always tidy and clean, so, there'd be a rules and instruction how to contribute to this framework.

  1. Clean and OOP Code

    Please always keep the code clean and optimized, and try to always use Object Oriented Programming (Classes).

  2. Discuss with others

    Please maintain a good communication between developers before working on new feature and make sure if someone hasn't working on a same thing already.

    You could discuss this with others on our Discord Server.

  3. Make Sure Your Code Is Pass The Testing

    We like to have the consistency of the code, so, please make sure your code is pass the testing. Use npm run lint or yarn lint command to run the test.

  4. Pull Request

    Always maintain to have your fork with the latest version on the upstream branch, and always make sure to have a pull request to different branch than the master branch.

Also, you don't have to update the documentation, the repository maintainers would handle that.

Steps

To do a pull request you just only need to do this:

  1. Fork this repository to your account (Must be forked!).
  2. Edit the forked repository.
  3. Go to pull request tab and click on New Pull Request button.

Learn more about pull request on here.