Skip to content

Latest commit

 

History

History
92 lines (58 loc) · 5.54 KB

CONTRIBUTING.md

File metadata and controls

92 lines (58 loc) · 5.54 KB
Raw

How you can contribute to FellCleave

👍🎉 First off, thanks for taking the time and/or interest to contribute! 🎉👍

The following is a set of guidelines for contributing to FellCleave and its guides. These are mostly guidelines, not rules. Use your best judgment, feel free to propose changes to this document in a pull request.

Code of Conduct

This project and everyone participating in it is governed by the FellCleave Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to contact@fellcleave.com.

I don't want to read this whole thing I just have a question!!!

Note: Please don't file an issue to ask a question.

We have an official Discord server, you can join it here:

  • Join the FellCleave Discord server
    • Even though Discord is a chat service, sometimes it takes several hours for community members to respond — please be patient!
    • Use the #github channel for general questions or discussion about the repo, questions about markdown syntax or how to start contributing.
    • Use the #general channel for questions about FellCleave and the team behind it
    • Use the #help-dps #help-healing #help-tanking channel if you are in need of extra information for your guide.
    • Use the #report-issues channel for reporting a new submited issue (you can simply post the link to it)
    • There are other channels available, fell free to check them out.

What should I know before I get started?

About FellCleave

FellCleave.com is a fan site dedicated to providing quality guides for the game FinalFantasy XIV. FellCleave was been build ontop of ❤️ Grav CMS ❤️ which is an open-source flat-file CMS. Our front end is done in YAML templating system and we use Markdown syntax as much as possible when working with our content.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for FellCleave, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.

When you are creating an enhancement suggestion, please include as many details as possible.

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which help you demonstrate the steps or point out the part of FellCleave which the suggestion is related to. You can use sharex or licecap to record GIFs on macOS and Windows, and silent or byzanz on Linux.
  • Explain why this enhancement would be useful to most FellCleave users.
  • List some other communities or websites where this enhancement exists, if it exists.

Your First Code Contribution

Unsure where to begin contributing to FellCleave? You can start by looking through these beginner and help-wanted issues:

  • [Beginner issues][beginner] - issues which should only require a few minutes of your time.
  • [Help wanted issues][help-wanted] - issues which should be a bit more involved than beginner issues.

Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.

Note: Please don't edit the upper part of any file that starts with 3 ---! You can edit anything below it.

Pull Requests

  • Do not include issue numbers in the PR title
  • Include screenshots and animated GIFs in your pull request whenever possible.
  • Follow the Markdown styleguides.
  • Include thoughtfully-worded, well-structured content, if you are working on a guide.
  • End all files with a newline

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line
  • When only fixing a typo, include [ci skip] in the commit description.
  • Consider starting the commit message with one or more applicable emoji:
    • 🎨 :art: when improving the format/structure of the code
    • 🐎 :racehorse: when improving readability of the texts
    • 📝 :memo: when writing docs or wikis for us.
    • 🐛 :bug: when fixing a rotation problem or quest requirement, or best in slot, etc.
    • 🔥 :fire: when releasing a new guide for a class that we didn't have one.
    • ✅ :white_check_mark: when adding more information to an existing guide.

Thanks! ❤️ ❤️ ❤️