Creating pull requests

This is a guide to creating a pull request to the Nova Rovers Demo repository.

Ways of creating a pull request

There are two alternative ways of creating a pull request. It solely depends on whether you have writing access to the repository.

1. Opening pull req. directly in the repo
2. Creating a fork to open a pull request

Opening pull request directly in the repo

This step is applicable if you've been added as a contributor to the repository.

Step 1: Clone the repository locally and make the changes to the branch. Please view the main README on guidance related to branching conventions.

Step 2: Push the code to the origin.

Step 3: Navigate to GitHub. Once you select your branch on GitHub you will an option to open a pull request.

Notes:

If you want to view your pull requests, you can do so from the 'Pull Requests' tab in the navbar.

Creating a fork to open a pull request

Step 1: Create a fork the main repository.

Step 2: Create a branch on your work and push to your forked repo.

Step 3: Navigate to the forked repo on GitHub. You should see a button to create a pull request on the main page.

Next Steps: Follow the images shown in the previous section under Step 3 to create a pull request.

Guidelines

When you're creating a pull request it is important to ensure that:

1. There are no merge conflicts
2. There are no useless files/folders (.vscode, .pycache, .gitignore, default config files etc.)
3. You can mention the major changes your commit is making in the pull request note.
4. If multiple pull requests have duplicated code, close one and make them into one.