Skip to content

Latest commit

 

History

History
104 lines (82 loc) · 5.47 KB

README.md

File metadata and controls

104 lines (82 loc) · 5.47 KB
Raw

Contributing to Repositories in Source-aasf

So you're interested in contributing to Source-aasf? Excellent! We appreciate your invaluable input! We want to make contributing to our projects as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

You can find our Code of Conduct here.

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Issue that pull request!

Essential git commands

A full git tutorial is beyond the scope of this document but this list describes the few git commands you are likely to encounter while contributing:

  • git clone makes a local copy of the project from GitHub on your system.
  • git fetch gets the latest development version of the project, which you will use as the basis for making your changes.
  • git status to see a list of files that have been modified or created.
  • git branch makes a logically separate copy of the project to keep track of your changes.
  • git add stages files you have changed or created for addition to git.
  • git commit adds your staged changes to the repository.
  • git push copies the changes you committed on your clone to GitHub.

Workflow Overview

These, conceptually, are the steps you will follow in contributing to repositories on Source-aasf:

  • Fork a repository and clone it locally.
  • Make a new feature branch; you will make your changes on this branch.
  • Follow The editing workflow to write/edit/document/test code - make frequent, small commits.
  • Push changes to feature branch on your fork.
  • From GitHub, ask for your changes to be reviewed to let the maintainers know you have contributions to review.
  • Make a pull request from GitHub.
  • Revise and push as necessary in response to comments on the pull request. Pushing those changes to GitHub automatically updates the pull request.

Detailed Workflow

  • Fork a repository and clone it locally.

Suppose you are interested in contributing to my-project repository on source-aasf. When you fork it, you will have the repository as 'your-github-username/myproject' To clone this locally, in your terminal window, run

git clone https://github.com/your-github-username/my-project.git
cd my-project

Now you have a local clone of project repository for development. You should also add the upstream repository. To do this, run

git remote add upstream https://github.com/source-aasf/my-project.git

Now if you run

git remote
origin
upstream

If you get this output, it means you have set up local repository correctly.

  • Make a new feature branch

When you are ready to make some changes to the code, you should start a new branch. Branches that are for a collection of related edits are often called ‘feature branches’. Making a new branch for each set of related changes will make it easier for someone reviewing your branch to see what you are doing.

Choose an informative name for the branch to remind yourself and the rest of us what the changes in the branch are for. Branch names like add-ability-to-fly or buxfix-for-issue-42 clearly describe the purpose of the branch. Always make your branch from my-project/master so that you are basing your changes on the latest version of the repository.

# Update the mirror of trunk
git fetch my-project

# Make new feature branch starting at my-project/master
git branch my-new-feature my-project/master
git checkout my-new-feature

  • Make changes to the code.

Then, to stage these changes run git add . if you want to add all changed files or git add <file_names> if you want to add specific files to the staging area. Then commit your changes with a meaningful message git commit -m "added new feature" and then push these changes to your fork. git push origin my-new-feature

  • Make a pull request

On GitHub, on your forked repo, switch your branch from dropdown menu to my-new-feature. You will see the message of how many commits your branch is ahead of upstream/master. Now click on Pull Request, enter a title for the set of changes, and some explanation of what you’ve done. If there is anything you’d like particular attention for, like a complicated change or some code you are not happy with, add the details here.

  • Revise and push as necessary

You may be asked to make changes in the discussion of the pull request. Make those changes in your local copy, commit them to your local repo and push them to GitHub. GitHub will automatically update your pull request.

Where to contribute?

Not sure what your first contribution should be? The best place to look for is in Issues. For beginners, look for issues with labels such asHelp wanted or Good first issue. If you are new to the git workflow of development, documentation related contributions can be a good place to start. And above all, the developers are friendly and want you to help, so don’t be shy about asking questions!!