Skip to content

Latest commit

 

History

History
115 lines (67 loc) · 2.6 KB

CONTRIBUTE.md

File metadata and controls

115 lines (67 loc) · 2.6 KB

Contribute to ngx-tag-commander

We're delighted that you're interested in contributing to ngx-tag-commander! This document is intended to outline the process and guidelines for contributing to this repository. We want to make contributing to this project as easy and transparent as possible.

Getting Started

  1. Fork the repository

Start by forking the repository on GitHub. This will create a personal copy for you to work on.

  1. Clone your fork

Clone your fork to your local machine. Replace your-username with your GitHub username.

git clone https://github.com/your-username/ngx-tag-commander.git
  1. Set up remote upstream

Add the original repository as an upstream remote to your local repository.

git remote add upstream https://github.com/CommandersAct/ngx-tag-commander.git
  1. Install dependencies

Navigate to the project directory and install its dependencies.

cd ngx-tag-commander
npm install

Making Changes

  1. Create a branch

Create a new branch for your changes.

git checkout -b feature/my-new-feature
  1. Make your changes

Edit, add, or delete files as necessary for your contribution.

  1. Follow the coding standards

Ensure your code adheres to the coding standards used throughout the project.

  1. Write tests

If you're adding new functionality, please write tests to accompany it.

  1. Run the tests

Ensure all tests pass before submitting your changes.

npm run test
  1. Document your changes

Update the documentation to reflect any changes you have made.

  1. Update the Sample App

Update the sample app found in src to reflect any changes you have made. Ensure that it is still running and add new examples if possible to illustrate your changes.

Submitting Changes

  1. Commit your changes

Commit your changes with a clear and descriptive commit message.

git commit -m "Add a brief description of your changes"
  1. Fetch upstream changes

Fetch any recent changes from the upstream master branch.

git fetch upstream
  1. Rebase your branch

Rebase your branch on top of the upstream master.

git rebase upstream/master
  1. Push your changes

Push your changes to your fork.

git push origin feature/my-new-feature
  1. Create a pull request

Go to your fork on GitHub and create a pull request against the CommandersAct/ngx-tag-commander 's master branch.

Reporting Issues

If you find any bugs or have a feature request, please create an issue on GitHub using the issue tracker.