kirbylife
/
numix-gtk-theme
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
numix-gtk-theme/.github/CONTRIBUTING.md

27 KiB
Raw Permalink Blame History

Contributing to the Numix Project

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

The following is a set of guidelines for contributing to the Numix Project and its visual works, which are hosted in the Numix Project Organization on GitHub. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

Table Of Contents

What should I know before I get started?

How Can I Contribute?

Style Guides

Additional Notes

What should I know before I get started?

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to numixproject@github.com.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for a Numix product/project. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.

Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Please try not to deviate away from the predefined issue template's format as doing so will delay the review of your issue.

Before Submitting A Bug Report

  • Most importantly, check to see if you can reproduce the problem while using the latest version of the product/project from its master branch.
  • Perform a cursory search to see if the problem has already been reported. If it has, add a thumbs up reaction to the existing issue instead of opening a new one. Only add comments to issues when you have new information to provide that is relevant to the issue.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. After you've determined which repository your bug is related to, create an issue on that repository and provide the following information.

Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem. The preferred format for issue titles is:
    • General Scope :: Specialized Scope :: One-sentence description of the issue
      • Example: GTK 3.20 :: Nautilus :: Active tab is not easily distinguishable from other tabs
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots and, when applicable, animated GIFs which clearly demonstrate the problem. You can use this tool or this tool to create animated GIFs on Linux.

Provide more context by answering these questions when applicable:

  • Did the problem start happening recently (e.g. after updating to a new version of the product) or was this always a problem?
  • If the problem started happening recently, can you reproduce the problem in an older version of the product? What's the most recent version in which the problem doesn't happen? You can download older versions of the product from its releases page.
  • Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.

Include details about your configuration and environment:

  • Which version of the product are you using?
  • What's the name and version of the distribution you're using?
  • Which version of GTK do you have installed?

Template For Submitting Bug Reports

When you create a new issue, you will see that a structured template has been pre-filled for you. Please try not to deviate away from the template.

Suggesting Enhancements

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

Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible. Try not to deviate away from the predefined issue template's format as doing so will delay the review of your issue.

Before Submitting An Enhancement Suggestion

  • Perform a cursory search to see if the enhancement has already been suggested. If it has, add a thumbs up reaction to the existing issue instead of opening a new one.

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. After you've determined which repository your enhancement suggestions is related to, create an issue on that repository and provide the following information:

  • Use a clear and descriptive title for the issue to identify the problem. The preferred format for issue titles is:
    • General Scope :: Specialized Scope :: One-sentence description of the suggested enhancement
      • Example: MATE Desktop :: Panel :: Add support for MATE Panel
  • Provide a detailed description of the suggested enhancement.
  • Include screenshots and, where applicable, animated GIFs which help you demonstrate the current vs. desired results or to point out the part of the product/project to which the suggestion relates. You can use this tool or this tool to create animated GIFs on Linux.
  • Explain why this enhancement is needed.
  • Specify which version of the product/project you're using..
  • Specify the name and version of the distribution you're using.

Template For Submitting Enhancement Suggestions

When you create a new issue, you will see that a structured template has been pre-filled for you. Please try not to deviate away from the template.

Your First Code Contribution

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

  • Beginner issues - issues that should only require a few lines of code.
  • [Help welcomed issues][help-welcomed] - issues that should be a bit more involved than beginner issues.

Both issue lists are sorted by total number of thumbs up reactions which is a reasonable proxy for the impact a given change will have.

Pull Requests

  • Every pull request should directly address at least one existing github issue. All activity related to the review of a pull request will be tracked on the github issue targeted by the pull request including comments, questions, feedback, etc.
  • If there is no existing github issue, you should create one prior to submitting your pull request.
  • Your commit message should directly reference the issue it addresses ("Fix #123" or "Fixes #123").
  • Pull requests should not include large scale changes. Always break up large scale changes into multiple pull requests.
  • Since most Numix products/projects are visual design oriented, always include before/after screenshots and, when applicable, animated GIFs in your pull requests.
  • Follow the Sass and CSS style guides.
  • End files with a newline.

Style Guides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Limit the first line to 72 characters or less
  • Reference issues and other pull requests liberally

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests. Most labels are used across all Numix repositories, but some are specific to numixproject/numix-gtk-theme.

GitHub search makes it easy to use labels for finding groups of issues or pull requests you're interested in. For example, you might be interested in open issues across numixproject/numix-gtk-theme and all Numix products/projects which are labeled as bugs, but still need to be confirmed (reliably reproduced) or perhaps open pull requests in numixproject/numix-gtk-theme which haven't been reviewed yet.

To help you find issues and pull requests, each label is listed with search links for finding open items with that label in numixproject/numix-gtk-theme only as well as across all Numix repositories. We encourage you to read about other search filters which will help you write more focused queries.

The labels are loosely grouped by their purpose, but it's not required that every issue have a label from every group nor that an issue can't have more than one label from the same group.

Please open an issue on numixproject/numix-gtk-theme if you have suggestions for new labels, and if you notice some labels are missing on some repositories, then please open an issue on that repository.

Type of Issue and Issue State

Label name numix-gtk-theme 🔎 numixproject‑org 🔎 Description
enhancement search search Feature requests.
bug search search Confirmed bugs or reports that are very likely to be bugs.
help-welcomed search search The Nunmix Project core team would appreciate help from the community in resolving these issues.
beginner search search Less complex issues which would be good first issues to work on for users who want to contribute to Numix.
needs-more-information search search More information needs to be collected about these problems or feature requests (e.g. steps to reproduce).
needs-confirmation search search Likely bugs, but haven't been reliably reproduced.
duplicate search search Issues which are duplicates of other issues, i.e. they have been reported before.
wontfix search search The Numix Project core team has decided not to fix these issues for now, either because they're working as intended or for some other reason.
invalid search search Issues which aren't valid (e.g. user errors).

Topic Categories

Label name numix-gtk-theme 🔎 numixproject‑org 🔎 Description
GTK search search Related to GTK.
KDE search search Related to KDE.
Xfce search search Related to Xfce.
Openbox search search Related to Openbox.
Unity search search Related to Unity.
Cinnamon search search Related to Cinnamon.
GNOME Shell search search Related to GNOME Shell.
GTK 2.0 search search Related to GTK 2.0.
GTK 3.16 search search Related to GTK 3.16.
GTK 3.18 search search Related to GTK 3.18.
GTK 3.20 search search Related to GTK 3.20.
GTK 3.22 search search Related to GTK 3.22.
metacity/mutter search search Related to Metacity/Mutter.

Pull Request Labels

Label name numix-gtk-theme 🔎 numixproject‑org 🔎 Description
work-in-progress search search Pull requests which are still being worked on, more changes will follow.
needs-review search search Pull requests which need code review, and approval from maintainers or Numix Project core team.
acknowledged search search Pull requests that have been acknowledged/claimed by a maintainer or Numix Project core team member for later review.
under-review search search Pull requests being reviewed by maintainers or Numix Project core team.
requires-changes search search Pull requests which need to be updated based on review comments and then reviewed again.
needs-testing search search Pull requests which need manual testing.