Skip to content

Latest commit

 

History

History
123 lines (84 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

123 lines (84 loc) · 2.48 KB
Raw

Contributing

Faker is a package provides a extensible framework for generating randomized fake data.

Philosophy

...

Aspirations

...

Installation

The following steps configures the local environment for developing on this project.

Setup

mkdir faker && cd faker

Fetch

git clone git@github.com:awncorp/faker.git .

Build

cpanm -llocal -qn --installdeps .

Validate

prove -Ilib -Ilocal/lib/perl5 -r t

Directory Structure

  lib
  ├── Faker.pm
  ├── ...
  │   └── ...
  t
  ├── ...
  └── Faker.t

Important! Before you checkout the code and start making contributions you need to understand the project structure and reasoning. This will help ensure you put code changes in the right place so they won't get overwritten.

The lib directory is where the packages (modules, classes, etc) are. Feel free to create, delete and/or update as you see fit. All POD (documentation) changes are made in their respective test files under the t directory.

POD isn't created and maintained manually, it is generated at-will (and typically before release). Altering POD files will almost certainly result in those changes being lost.

Developing

This project uses git as its version control system and is managed on GitHub. All code changes must be based on GitHub issues (tickets) and can only be merged into the master branch using pull requests. In order to trigger the necessary CI/CD workflows, pull requests must be based on branches with the naming scheme of issue-n where n is the GitHub issues number (found in the URL), e.g. issue-1.

Create or find an issue on GitHub:

open https://github.com/awncorp/faker/issues/1

Create a local branch based on the issue (ticket) number (found in the URL):

git checkout master
git pull origin master
git checkout -b issue-1

Make some code changes and push the branch to the remote:

git push origin issue-1

Testing

Running the test suite using prove:

prove -Ilib -Ilocal/lib/perl5 -r t

Experiment

Experiment with the code using perl (REPL):

perl -Ilib -Ilocal/lib/perl5 -MFaker -de0

Experiment with the code using the reply (REPL):

reply -Ilib -Ilocal/lib/perl5 -e 'use Faker'

Support

Questions, Suggestions, Issues/Bugs

Please post any questions, suggestions, issues or bugs to the issue tracker on GitHub.