Initial steps

When starting any project, you'll need to set up your workspace, version control, and repository. For a port, this is largely dictated by whatever the upstream project has setup (meaning original or the version you are making changes to).

For git projects hosted on GitHub and GitLab, the standard way of contributing is to fork the repository (GitHub or GitLab), make any changes you can there, and then open a Pull or Merge Request for maintainers to review. Some maintainers require a separate process or have additional requirements. The best way to find out how to contribute is to look for a README.md or CONTRIBUTING.md file in the original project.

Note:

Be aware that not all licenses allow for distribution of modified code or may restrict commercial use. Please ensure you follow all license details.

Summary of Steps:

  1. Check for a port elsewhere.

  2. Review the source code's README.md and CONTRIBUTING.md.

  3. If needed, fork the repository.

Page updated: