UC San Diego - Experimental

UC San Diego - Experimental is the rolling release of the UC San Diego Mobile app. This rolling release is for users interested in developing for, and experimenting with, the absolute latest version of the UC San Diego Mobile app.

This version is intended for developers and designers and is absolutely, 100% NOT recommended for daily use. Rolling releases are not subject to the rigorous testing of the regular production release. Many things may (and probably are) only partially complete and are likely broken.

If your feature or enhancement is selected as a possible release candidate, due to its sheer awesomeness or immediate need, it will go through an additional vetting process. Who knows? Your idea could be included in the next production release and help students navigate their UC San Diego experience for many classes to come. And give you a nice feather in your cap to show potential employers. If successful, your feature or enhancement will be published to the UC San Diego mobile app for its 30,000 users to experience, and you will be added as a collaborator on mobile.ucsd.edu.

We look forward to helping you become a published app developer!

How to Contribute

Creating a Fork

From the Campus Mobile GitHub page click the "Fork" button. Next, use your favorite git client or command line to clone the repo:

# Clone your fork to your local machine
git clone [email protected]:YOUR-USERNAME/campus-mobile.git

Keeping Your Fork Up to Date

You'll want to make sure you keep your fork up to date by tracking the original "upstream" repo that you forked. To do this, you'll need to add a remote:

# Add 'upstream' repo to list of remotes
git remote add upstream https://github.com/UCSD/campus-mobile.git

Whenever you want to update your fork with the latest upstream changes, you'll need to first fetch the upstream repo's branches and latest commits to bring them into your repository:

# Fetch from upstream remote
git fetch upstream

Your local experimental branch is now up-to-date with any changes upstream.

Doing Your Work

Create a Feature Branch

When you begin working on a new feature or bugfix, it is important that you create a new branch. Not only is it proper git workflow, but it also keeps your changes organized and separated from the experimental branch so that you can easily submit and manage multiple pull requests for every task you complete.

To create a new branch and start working on it:

# Checkout the experimental branch
git checkout experimental

# Create and switch to a new branch named newfeature
git checkout -b newfeature

You are now ready to begin developing your new feature. Commit your code often, using present-tense and concise verbiage explaining the work completed.

Here is an example of how to commit and push code for your newfeature.

# Add your code
git add lib/Main.dart

# Commit your code
git commit -m "Add environment variable replacement"

# Push your code
git push -u origin newfeature

Submitting a Pull Request

Once you've committed and pushed your feature branch newfeature to GitHub, go to the page for your fork on GitHub, select branch newfeature and click the 'New pull request' button.

If you need to make future updates to your pull request, push the updates to your feature branch newfeature on GitHub. Your pull request will automatically track the changes on your feature branch and update.