Skip to content

Latest commit

 

History

History
57 lines (40 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

57 lines (40 loc) · 2.17 KB
Raw

Contributing

Found a bug or want to add a feature?

Please open an issue before submitting a pull request!

Since the master branch is what people actually use in production, we have a dev branch that unstable changes get merged into first. Only when we consider that stable we merge it into the master branch and release the changes for real.

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/<your-username>/babel-plugin-filenamespace.git
# Navigate to the newly cloned directory
cd babel-plugin-filenamespace
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/samit4me/babel-plugin-filenamespace.git

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

    git checkout dev
git pull upstream dev

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

    git checkout -b <topic-branch-name>

  4. Commit your changes in logical chunks. Please adhere to these git commit message guidelines or your code is unlikely be merged into the main project. Use Git's interactive rebase feature to tidy up your commits before making them public.

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

    git pull [--rebase] upstream dev

  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 submitting a patch, you agree to allow the project owners to license your work under the terms of the MIT License.