Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 2.15 KB

CONTRIBUTING.md

File metadata and controls

46 lines (28 loc) · 2.15 KB
Raw

Welcome to contribution guidelines

Thank you for taking time to contribute to Hugo blog awesome!

Following the contribution guidelines helps both owners and contributors. The guidelines save time and hassle caused by improperly created pull requests or issues that might have to be rejected and re-submitted.

When to use issues?

We prefer to use issues for reporting real 'issues' or bugs. For feature requests you can visit the feature request section of Discussions and start a new thread. For questions you can visit Q&A section of Discussions.

Pull requests (PR)

  • Please ensure that you have filled answers to as many questions as applicable, while creating a PR.
  • We recommend you to create atomic PRs which focus on a single change.
  • We do recommend PRs to not exceed 200 lines (includes additions and deletions) of code.
  • Kindly ensure that you are NOT addressing multiple issues in one PR.

Adding a new language

If you are adding support for a new language, you have to do the following:

  1. Add language specific configuration and parameters in exampleSite/hugo.toml
  2. Translate specific terms by creating a new language-specific file in the i18n directory
  3. Add translated content in exampleSite/content directory

You can take a look at this Pull request for reference.

Commits

This project adheres to Conventional Commits specification.

Releases

We use Semantic Versioning for releases.

Changelog

You don't have to edit the CHANGELOG.md file. The changelong is auto generated. A GitHub action workflow is in place, which:

  • analyses the commits (from last release)
  • determines the version to bump (it's doable since this project adheres to conventional commit specification)
  • updates the changelog
  • creates a git tag corresponding to the version

Finally it creates a PR with the above changes. So, there is no manual editing required.