Skip to content

Latest commit

 

History

History
58 lines (36 loc) · 2.91 KB

CONTRIBUTING.md

File metadata and controls

58 lines (36 loc) · 2.91 KB
Raw

Contribute to CodeEdit

Feel free to join and collaborate on our Discord Server.

Warning

Please do not submit localization related pull requests at this time. Once we are ready to support more languages we will let you know with a guide on how to contribute here and on our Discord Server.

Fork & Clone CodeEdit

Tap the "Fork" button on the top of the site. After forking clone the forked repository to your Mac.

Explore Issues

Find issues from the Issues tab or from the To Do column in our project. If you find an issue you want to work on, please indicate it in the issue and/or attach a draft PR once available. An admin or maintainer will then assign the Issue and/or PR to you.

Important

Please make sure to first comment under an issue or ask a maintainer to assign you to the issue before working on it. This helps prevent multiple people from working on the same thing, which could result in your work not being merged. Additionally, some issues might be reserved for those with more in-depth knowledge of the codebase.

Getting Started

Please read the Getting Started guide in our wiki.

We also have a troubleshooting guide that provides common resolutions.

Code Style

Please read our guide on Code Style in our wiki.

Pull Request

Once you are happy with your changes, submit a Pull Request.

The pull request opens with a template loaded. Fill out all fields that are relevant.

The PR should include following information:

  • A descriptive title on what changed.
  • A detailed description of changes.
  • If you made changes to the UI please add a screenshot or video as well.
  • If there is a related issue please add a reference to the issue. If not, create one beforehand and link it.
  • If your PR is still in progress mark it as Draft.

Checks, Tests & Documentation

Request a review from one of our admins @austincondiff, @lukepistrol, @MarcoCarnevali, @jasonplatts, @pkasila or maintainers @cstef, @linusS1, @RayZhao1998, @wdg.

Tip

If it is your first PR, an admin will need to request a review for you.

Important

Please resolve all Violation errors in Xcode (except: TODO: warnings). Otherwise the swiftlint check on GitHub will fail.

Once you submit the PR GitHub will run a couple of actions which run tests and SwiftLint (this can take a couple of minutes). Should a test fail, it cannot be merged until tests succeed.

Make sure to resolve all merge-conflicts otherwise the PR cannot be merged.

Important

Make sure your code is well documented so others can interact with your code easily!