Skip to content

Latest commit

 

History

History
61 lines (38 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

61 lines (38 loc) · 1.64 KB
Raw

Contributing Guidelines

Looking to contribute something? Here's how you can help.

Bugs reports

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!

Guidelines for bug reports:

  1. Use the GitHub issue search — check if the issue has already been reported.

  2. Check if the issue has been fixed — try to reproduce it using the latest main or development branch in the repository.

  3. Isolate the problem — ideally create a reduced test case and a live example.

  4. Please try to be as detailed as possible in your report. Include specific information about the environment - operating system and version, browser and version... and steps required to reproduce the issue.

Making Changes

If you'd like to contribute please follow these instructions.

Fork this repo on GitHub

Setup

  1. Clone your fork
git clone https://github.com/$YOUR_USERNAME/opensource-website/
cd opensource-website
  1. Install Hugo

Install Hugo

  1. Start Hugo server

Hugo Server

hugo server

Pull requests

Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

  1. Push your topic branch up to your fork: git push origin my-feature-branch

  2. Open a Pull Request with a clear title and description. One for your changes in main.