Contributing

We welcome contributions to activerecord-multi-tenant! This section provides guidelines for contributing to the project.

Overview of the Development Process

activerecord-multi-tenant is developed using a standard fork and pull request model. The activerecord-multi-tenant GitHub repository is the starting point for code contributions.

Guidelines for Contributing

Fork the Repository: Start by forking the official activerecord-multi-tenant repository to your own GitHub account.

Clone the Repository: Clone the forked repository to your local machine and add the official repository as an upstream remote:

$ git clone https://github.com/citusdata/activerecord-multi-tenant.git
$ cd activerecord-multi-tenant
$ git remote add upstream https://github.com/your-github-account/activerecord-multi-tenant.git

Create a Feature Branch: Create a new branch for each feature or bugfix:
```
$ git checkout -b my-feature-branch
```
Commit Your Changes: Make your changes and commit them to your feature branch.
Push to GitHub: Push your changes to your fork on GitHub:
```
$ git push origin my-feature-branch
```
Submit a Pull Request: Open a pull request from your feature branch to the master branch of the official activerecord-multi-tenant repository.

Please ensure your code adheres to the existing style conventions of the project. Include tests for any new features or bug fixes, and update the documentation as necessary.

Setting Up a Development Environment

To set up a development environment for activerecord-multi-tenant, follow these steps:

Clone the repository as described in the contributing guidelines.
Install the required dependencies:
```
$ bundle install
```
Run the tests to ensure everything is set up correctly:
```
$ bundle exec rake spec
```
Compile documentation for the project:
```
$ cd docs
$ make pre-build
$ make html
```