Skip to content

Latest commit

 

History

History
65 lines (53 loc) · 2.02 KB

CONTRIBUTING.md

File metadata and controls

65 lines (53 loc) · 2.02 KB
Raw

Contributing to Fast Static Site Generator

Welcome to the Contribution Page! This page provides useful information about contributing to the tool

Contribution Process

The contribution process starts with filing an issue on GitHub issue page. We define 4 categories of issues:

  • Feature Request
  • Bug Reports
  • Documentation
  • Installation Issues

Once you filed an issue, you may begin working on implementing a feature or fixing a bug. Lastly, create your Pull Request with an explanation of changes you have made. One of the members of the tool will review your Pull Request.

Congratulations, you have contributed to the Tool!

Contribution Guidelines

In this section, we provide guidelines to consider as you develop new features or bug fixes.

Installing dependencies

Before you begin working with tool, you need to install required dependencies.

pip3 install -r requirements.txt

If you plan on doing development and testing, you will also need to install the dependencies dedicated for testing.

pip3 install -r dev-requirements.txt

Developing and Testing the Tool

Once you develop a new feature or fix a bug, we recommend running a code formatter. We use Black to ensure a consistent code format. You can run auto-format your code by running:

black .

Then, verify that linter pass before submitting a Pull Request by running:

flake8 .

Verify that unit tests pass before submitting a Pull Request by running:

pytest tests/

You can run all the tests and code-formatting in one-step by running:

./run_python_tests.sh

Releasing

Releases are published automatically when a tag is pushed to GitHub.

    # Set next version number
   export RELEASE=x.x.x

   # Create tags
   git commit --allow-empty -m "Release $RELEASE"
   git tag -a $RELEASE -m "Version $RELEASE"

   # Push
   git push upstream --tags

Pushing upstream assumes we are working from a fork, if we are not doing that that it would be:

    git push origin --tags