Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
94 lines (66 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

94 lines (66 loc) · 2.57 KB

Contributing to Yet Another React Lightbox

First off, thank you for your interest in Yet Another React Lightbox! All contributions of all sizes are always welcome here. Here are a few guidelines that will help you along the way.

Code of Conduct

Yet Another React Lightbox has adopted the Contributor Covenant as its Code of Conduct, and we expect project participants to adhere to it. Please read the full text so that you can understand what actions will and will not be tolerated.

Submitting an Issue

Before you commit your time to code a new feature or a bug fix, be sure to open a feature request or a bug report under the project Issues to be sure your PR will be accepted once done.

Sending a Pull Request

  1. Fork the repository.

  2. Clone the fork to your local machine and add upstream remote:

git clone https://github.com/<your username>/yet-another-react-lightbox.git
cd yet-another-react-lightbox
git remote add upstream https://github.com/igordanchenko/yet-another-react-lightbox.git
  1. Synchronize your local main branch with the upstream:
git checkout main
git pull upstream main
  1. Install the dependencies with npm:
npm install
  1. Create a new head branch:
git checkout -b feat/my-new-feature
  1. Start auto-build script:
npm run start
  1. Link-install your locally built yet-another-react-lightbox version to your local project:
# specify relative or absolute path to yet-another-react-lightbox directory 
YARL_HOME=../yet-another-react-lightbox
npm link $YARL_HOME $YARL_HOME/node_modules/react $YARL_HOME/node_modules/react-dom
rm -rf node_modules/.cache
  1. Make changes, run tests:
npm run test
  1. Cleanup global link:
# execute from your local project directory
npm install
rm -rf node_modules/.cache
npm rm -g yet-another-react-lightbox react react-dom
  1. Commit and push to your fork (make sure your commit message conforms to the conventional commits):
git commit -m "feat: awesome new feature"
git push -u origin HEAD
  1. Go to the repository and create a Pull Request.

License

By contributing your code to the yet-another-react-lightbox GitHub repository, you agree to license your contribution under the MIT license.