Available translations
loading results
App Contribute Command
Summary: This command allows you to contribute work to the project. The contribution goes to the Superalgos repository via a Pull Request from your Superalgos fork.
This command will send all changes you have made in Docs pages but also on any file within the Superalgos folder (except for My-Workspaces, Data-Storage, and My-Logs folders) to your fork at Github.com. It will also send them from your fork to the main Superalgos Repository. It will do it specifically from the Current Branch to the Contributions Branch mentioned at the footer of this page.
Warning: Never use your Superalgos folder to store personal files, as the whole folder but the few exceptions mentioned above are subject to be sent over the Internet to a public site.
Warning: The Plugins-Docs Branch is OUTDATED. All contributions now go to the develop branch. If you got questions regarding to that, feel free to ask in the Telegramm groups.
Important: In most cases, contributions must go from the develop branch to the develop branch, unless you have previously agreed with team members that you will send a contribution from master to master.
Master is our stable branch and it is very unlikely that we are going to merge contributions there. Instead, all contributions are expected to go to the develop branch, where many users are testing that branch every day. Contributions to the develop branch will reach the master branch on the next release.
Note: It is also very unlikely that contributions coming from the master branch will be merged into the develop branch, since that can usually lead to merging conflicts.
Tip: Check the footer of the Docs to verify what branches you are operating with before submitting your contributions!
Syntax
app.contribute [Message] Parameters
- Message: Enter a brief description of what your contribution is about. It is optional but appreciated.
Example
app.contribute Fixed typo. For Devs
This is what the command does:
- git.add: adds the changes you've made to contributable files to a git commit.
- git.commit: commits all the changes.
- git.push: pushes the changes to your fork.
- github.createPullRequest: creates a Pull Request at the Superalgos repository, or add commits to an existing Pull Request.
Block Authentication
Authentication
For the App Contribute Command to run properly, two different authentications are required:
- Git Authentication: The first time you run this command, Git will open a pop up window that will ask you for your Github.com credentials. This happens only once. Git will use these credentials to push the commit to your Superalgos fork at Github.com.
- Github.com Authentication: The creation of the Pull Request is something that happens at Github.com and for this operation you need to authenticate too. To do this, you must generate a Personal Access Token and set it up at the Github Api node configuration in your active workspace.
GitHub.com Token
- Create the token by following this link:
Github API Node
Once you have your token, find the GitHub API node (you may search for it in the Documentation). The configuration looks like this:
{
"username": "",
"token": ""
} If you can't find the node by using the search box, it may not exist in the active workspace. The APIs hierarchy is included by default in the Getting Started workspace only. You may spawn a new APIs hierarchy from the Other Hierarchies node in the Foundations Project hierarchy.
Properties
- username: Type your GitHub.com username.
- token: Paste the token you created.
Note: You may run the command any time after you made and saved changes.
Troubleshooting Authentication Issues
Some issues may arrise when you have more than one Git installation active in your OS.
For example, if you see the following authentication screen, it means an older version of Git is trying to deal with the authentication:
The current authentication screen is similar to this one instead:
Important: If you didn't install the latest version of Git before installing Superalgos, then that is likely the reason the authentication is not working. The latest version of Git is required.
Tip: If you did install Git and you are experiencing the issue described above, restarting your PC may help things sort themselves out.
Linux and macOS
Tip: Input your personal authentication token (PAT) in place of your password and hit enter.
If you don't want to keep entering in your token then you can have git cach your credentials: