Skip to content

Latest commit

 

History

History
83 lines (59 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

83 lines (59 loc) · 2.86 KB
Raw

Great to have you here. Here are a few ways you can help make this project better!

The issue tracker is the preferred channel for bug reports, features requests and submitting pull requests.

You can use mailing list to ask any questions or share your ideas https://groups.google.com/group/runtimejs

Feature requests

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.

Pull requests

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

Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.

Please adhere to the coding conventions used throughout a project (indentation, accurate comments, etc.).

Follow this process if you'd like your work considered for inclusion 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/<your-username>/runtime
# Navigate to the newly cloned directory
cd runtime
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/runtimejs/runtime

  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.

    Warning: If you modify /deps, please make separate commit for every dependency library you change.

  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.

IMPORTANT: By contributing to Runtime.JS, you agree that your contributions will be licensed under the Apache License Version 2.0 (APLv2).