Skip to content

Latest commit

 

History

History
72 lines (47 loc) · 3.61 KB

CONTRIBUTING.md

File metadata and controls

72 lines (47 loc) · 3.61 KB

Contributing to SnowFS

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

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

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

If you are a software developer👷, an artist 🧑‍🎨, someone who is working for a DCC software, or if you are simply interested in this project, we would love to connect with you!

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

Feel free to contact us directly at support@snowtrack.io. If chat is more your speed, you can send us a message on Discord.

  • Join the Discord Chat
    • Even though Discord is a chat service, it might take a few hours to respond — please be patient!
    • Use the #snowfs channel for questions about SnowFS
    • Use the #snowtrack channel for general questions or discussions about Snowtrack

Reporting Bugs

If you found an issue, please report an issue.

Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

Your First Code Contribution

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

  • [Beginner issues][beginner] - issues which should only require a few lines of code, and a test or two.
  • [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.

Pull Requests

Please follow these steps to have your contribution considered by the maintainers:

  1. Follow all instructions in the template

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
  • Optionally you can add applicable emoji to your commit message:
    • 🎨 :art: when improving the format/structure of the code
    • 🐎 :racehorse: when improving performance
    • 🚱 :non-potable_water: when plugging memory leaks
    • 📝 :memo: when writing docs
    • 🐧 :penguin: when fixing something on Linux
    • 🍎 :apple: when fixing something on macOS
    • 🏁 :checkered_flag: when fixing something on Windows
    • 🐛 :bug: when fixing a bug
    • 🔥 :fire: when removing code or files
    • 💚 :green_heart: when fixing the CI build
    • ✅ :white_check_mark: when adding tests
    • 🔒 :lock: when dealing with security
    • ⬆️ :arrow_up: when upgrading dependencies
    • ⬇️ :arrow_down: when downgrading dependencies
    • 👕 :shirt: when removing linter warnings

Code of Conduct

This project and everyone participating in it is governed by the Snowtrack Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to service@snowtrack.io.

Documentation Styleguide

** TODO