Thanks for choosing to contribute and taking the time to read this!
We are try to make contributing to this project as easy and transparent as possible. Hopefully this document answers all your questions regarding the process for contributing to Infinite Ajax Scroll.
This project adheres to the Infinite Ajax Scroll Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to hello@webcreate.nl.
We use a branching model called Trunk-Based Development. This means that all commits are against the master branch and that we do our best to keep it in good shape, with tests passing at all times.
Older versions are moved to a separate branch. For example, version 2 resides in the 2.x branch. Previous versions are kept for reference.
Infinite Ajax Scroll follows semantic versioning. We release patch versions for bugfixes, minor versions for new features, and major versions for any breaking changes.
Every significant change is documented in the changelog file.
We are using Github Issues for issue tracking. Before filing a new issue, try to make sure your problem does not already exist.
The best way to get your bug fixed is to provide a reduced test case or a live url. This Codesandbox is a good great starting point for a reduced test case.
Security issues shouldn't be reported on this issue tracker. See our security policy for more information.
- You have Node and NPM installed
- You have GNU Make installed
- You are familiar with Git.
We use ESLint to catch most coding style issues. You can check the status of
you code styling by running npm run lint
.
We also provide a .editorconfig
which your IDE can use.
Want to try a new feature that has landed in master? Follow these instruction to generate dist files locally.
-
Clone the repository
git clone git@github.com:webcreate/infinite-ajax-scroll.git
-
Install the project dependencies
npm install
-
Build dist files
npm run build --production
You can find the dist files in the /dist folder.
Follow these steps to start working on a new feature or bugfix.
-
Clone the repository
git clone git@github.com:YOUR_USERNAME/infinite-ajax-scroll.git
-
Install the project dependencies
make install
-
Start the webserver
make up
-
Start watching for changes
npm run watch &
Also start watching any example that you want to use:
cd examples/article && npm run watch &
-
Create a feature branch
git checkout -b name-of-feature-branch
-
Work on your feature or bugfix
-
Run the test suits
npm run test
or to test with a GUI
npm run cypress
-
Commit and push to your fork
-
Create a pull request on Github
By contributing to Infinite Ajax Scroll, you agree that your contributions will be licensed under the Infinite Ajax Scroll License.