asandikci.com/web
1
0
Fork 0
Code Issues 5 Pull requests Projects Releases Packages Wiki Activity Actions
web/docs/CONTRIBUTING.md
Cotes Chung 7b43a83c40
refactor: move project files to docs folder
2023-08-19 12:55:24 +08:00

5.5 KiB
Raw Blame History

Contributing Guidelines

🎉 First of all, thank you for considering contributing to this project! 🎉

There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into Chirpy itself.

In This Article

General Rules

All contributions should be based on the following rules:

  • You should read through the Wiki to understand the project features and how to use it properly. This is to respect the time of the project's developers and maintainers, and to save their energy for other problems that really need to be resolved.

  • Use the latest release version. If your contribution involves code/documentation changes, update to the latest version of the default (master) branch.

  • Avoid making duplicate contributions by searching for existing Issues / Discussioins / Pull Requests, but don't leave any unhelpful comments such as "I have the same problem". Prefer using reactions if you simply want to "+1" an existing issue.

  • DO NOT email or tweet the project developers and maintainers directly, everything about Chirpy should be left in GitHub.

Tips: If you're new to open source, see "How To Ask Questions The Smart Way".

Questions and Requests for Help

We expect every reasonable question you ask to be answered appropriately. If you want a quick and timely response, please ask questions at Jekyll Talk and StackOverflow, where there are tons of enthusiastic geeks who will positively answer your challenging questions.

If you can't get an answer in any of the above ways, then create a new discussion. As long as it is not a duplicate and RTFM / STFW issue, we will respond as soon as possible.

File a Bug Report

A great way to contribute to the project is to send a detailed issue when you encounter a problem. We always appreciate a well-written, thorough bug report.

  1. Please figure out why the bug occurred, or locate the module in the project that caused this bug. Otherwise, there is a high probability that you are using/setting it incorrectly.

  2. If the issue is caused by you modifying the project code or some configuration of Jekyll, then please DO NOT report such "bugs". Chirpy is an open-source project, but that doesn't mean we will maintain other specific forks (such as yours). You can learn about Jekyll and modern Web development to solve problems caused by custom modifications.

  3. Make good use of your browser's incognito mode to troubleshoot if the problem is caused by caching.

  4. As a last option, you can create a new Bug Report follow the template to describe the details. If possible, providing a demo that reproduces the error will help us troubleshoot faster.

Suggest a New Feature

Feature requests are welcome! While we will consider all requests, we cannot guarantee your request will be accepted.

We want to avoid chaos in the UI design, so we won't accept requests for changes like color schemes, font families, typography, and so on. Do not open a duplicate feature request. Search for existing feature requests first. If you find your feature (or one very similar) previously requested, comment on that issue.

If accepted, we cannot make any commitments regarding the timeline for implementation and release. However, you are welcome to submit a pull request to help!

Contributing Code and Documentation Changes

In short, you can follow these steps to complete the contribution.

  1. Fork this project on GitHub and clone your repository locally.
  2. Setting up the development & test environments.
  3. Create a new branch from the default branch and give it a descriptive name (e.g. add-a-new-feat or fix-a-bug). When development is complete, create a Conventional Commit with Git.
  4. Create a new Pull Request.

Helpful Resources