Skip to content

Latest commit

 

History

History
67 lines (48 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

67 lines (48 loc) · 2.37 KB
Raw

Contributing to CacheManager.Serialization.Hyperion

CacheManager.Serialization.Hyperion is developed and maintained by Armut.com developer team.

All kind of pull requests even for things like typos, documentation, test cases, etc are always welcome. By submitting a pull request for this project, you agree to license your contribution under the MIT license to this project.

Getting Started

  • Make sure you have a GitHub account
  • Submit a ticket for your issue, assuming one does not already exist.
    • Clearly describe the issue including steps to reproduce the bug.
  • Fork the repository on GitHub

Pull requests

Good pull requests, patches, improvements and new features are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Adhering to the following process is the best way to get your work included in the project:

  1. Fork the project, clone your fork, and configure the remotes:

    # Clone your fork of the repo into the current directory
git clone https://github.com/<user-name>/CacheManager.Serialization.Hyperion.git
# Navigate to the newly cloned directory
cd <folder-name>
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/armutcom/CacheManager.Serialization.Hyperion.git

  2. If you cloned a while ago, get the latest changes from upstream:

    git checkout master
git pull upstream master

  3. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:

    git checkout -b <topic-branch-name>

  4. Commit your changes in logical chunks. Use Git's interactive rebase feature to tidy up your commits before making them public.

  5. Locally merge (or rebase) the upstream development branch into your topic branch:

    git pull [--rebase] upstream master

  6. Push your topic branch up to your fork:

    git push origin <topic-branch-name>

  7. Open a Pull Request with a clear title and description against the master branch.