Skip to content

Latest commit

 

History

History
68 lines (53 loc) · 3.63 KB

README.md

File metadata and controls

68 lines (53 loc) · 3.63 KB
Raw

Sketchware Pro

GitHub contributors GitHub last commit

This is for everyone who wants to contribute to Sketchware Pro's development.

There are few things that must be taken into consideration before contributing to Sketchware Pro:

  • Make sure that you're capable to mod.
  • Showing off on other contributors is seriously not allowed. We're a community.
  • When you fix, add or modify something in Sketchware Pro, write an explanation about what you've done, at best as comment of the commit adding the file to the repository.

How to contribute

  • Fork the repository to your GitHub account
  • Make a branch if necessary
  • Clone the forked repository to your local device (optional, you can edit the files through GitHub's web interface)
  • Make changes to files
  • Test those changes
  • Create a pull request in this repository
  • The repository members will review your pull request, and merge it when they are accepted.

Source code map

  • Jx -> Responsible for generating the source code of activities.
  • Lx -> Responsible for generating source codes of stuff such as listeners etc.
  • Ox -> Responsible for generating the xml source of layouts.
  • Dp -> Responsible for the whole compilation process of projects. Was modified to fix MultiDex bug and to add library support.
  • yq -> Organizes Sketchware projects' file paths.
  • tq -> Responsible for compilation dialog quizzes.

You may also check mod path that has the majority of contributors changes.

Some guidelines for commits follow.

Commit message

When you've made changes to one or more files, you have to commit that file. You also need a message for that commit.

You should read these guidelines: https://www.freecodecamp.org/news/writing-good-commit-messages-a-practical-guide/

And that summarized:

  • Short and detailed
  • Prefix one of these commit types:
    • feat: A feature, possibly improving something already existing
    • fix: A fix, for example of a bug
    • style: Feature and updates related to styling
    • refactor: Refactoring a specific section of the codebase
    • test: Everything related to testing
    • docs: Everything related to documentation
    • chore: Code maintenance (you can also use emojis to represent commit types)

Examples:

  • feat: Speed up compiling with new technique
  • fix: Fix crash during launch on certain phones
  • refactor: Reformat code at File.java
  • ...

Thanks for contributing

Thanks, they help to keep Sketchware Pro alive. It's better to have multiple people work on a project, for more ideas, less bugs (sadly sometimes more), and generally quicker development. Each (helpful) contribution that gets thankfully accepted, gets noted down in the "About Modders" activity. We'll contact you how to note your contributions to Sketchware Pro.

Discord

Join our Discord Server: Sketchware Pro

Disclaimer

This mod was not meant for any harmful purposes, such as harming Sketchware; Quite the opposite actually. It was made to keep Sketchware alive by the community for the community. Please use it at your own discretion and buy the Sketchware Premium subscription every month to support the original Sketchware team, even if you don't use it.

We love Sketchware very much, and we are grateful to Sketchware's developers for making such an amazing app, but unfortunately, we haven't received updates for a long time. That's why we decided to keep Sketchware alive by making this mod, plus we don't demand any money, it's completely free. :)