Skip to content
This repository has been archived by the owner on Jun 19, 2020. It is now read-only.

Latest commit

 

History

History
118 lines (81 loc) · 3.28 KB

CONTRIBUTING.md

File metadata and controls

118 lines (81 loc) · 3.28 KB
Raw

Contributing Guidelines

We love contributions! But we'd like you to follow these guidelines to make the contribution process easy for everyone involved:

Issue Tracker

The issue tracker is our main channel to report a bug in the source code or a mistake in the documentation, and to request a new feature.

Before submitting your issue, please search the archive. Maybe your question was already answered, your bug has already been reported or your feature has already been requested.

Providing the following information will increase the chances of your issue being dealt with quickly:

  • Bug reports - if an error is being thrown, please include a stack trace and the steps to reproduce the error. If there is no error, please explain why do you consider it a bug.

  • Feature Requests - please make it clear whether you're willing to write the code for it or you need someone else to do it.

  • Related Issues - if you found a similar issue that has been reported before, be sure to mention it.

Pull Requests

Before making any changes, consider following these steps:

  1. Search for an open or closed Pull Request related to your changes.

  2. Search the issue tracker for issues related to your changes.

  3. Open a new issue to discuss your changes with the project owners. If they approve it, send the Pull Request.

Sending Pull Requests

If your change has been approved, follow this process:

  1. Fork the project, clone your fork and configure the remotes:
# Clone your fork into the current directory
git clone https://github.com/<your-username>/<repo-name>
# Navigate to the newly cloned directory
cd <repo-name>
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/rosariopfernandes/firextensions
  1. Make your changes in a new branch:
git checkout -b my-fix-branch master
  1. Commit the changes using a descriptive commit message
git commit -a

Note: the optional commit -a command line option will automatically "add" and "rm" edited files.

  1. Push your branch to GitHub:
git push origin my-fix-branch
  1. In GitHub, send a Pull Request with a clear title and description.
  • If we suggest changes then:
    • Make the required changes;
    • Rebase your branch and force push to your GitHub repository (this updates your Pull Request): 
      # Rebase the branch
git rebase master -i
# Update the Pull Request
git push origin my-fix-branch -f

That's it! Thank you for you contribution!

After your Pull Request is merged

You can delete your branch and pull changes from the original (upstream) repository:

  1. Delete the remote branch on GitHub either through the GitHub UI or your local shell as follows:
git push origin --delete my-fix-branch
  1. Check out the master branch:
git checkout master -f
  1. Delete the local branch:
git branch -D my-fix-branch
  1. Update your master with the latest upstream version:
git pull --ff upstream master

Coding Rules

We generally follow the Android Kotlin Style Guide.