Skip to content

Latest commit

 

History

History
23 lines (17 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

23 lines (17 loc) · 1.51 KB

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct here, please follow it in all your interactions with the project.

Issue process

  1. Create an issue from one of the existing templates (bug or feature).
    1. Bug: A bug can only be related to image renaming. If you know the character represented in the image and the name doesn't fit it, feel free to create a bug issue and rename it.
    2. Feature: A new image or a bundle of images must be handle by a feature issue. Please insert the name of the image in the title. If it is a bundle of images, please insert the names in the description.
  2. Create a new branch and link it to the issue.
    • Naming rule: the name of the new branch must be [the type of the issue]/TUX-AVATAR-PROJECT-[issue number]. Remember that the type of the issue only can be bugfix or feature.
  3. Move the issue to In progress.

Pull Request Process

  1. Ensure any temporary file is removed before pushing the changes.
  2. Ensure that the minimum image size is 256x256 pixels.
  3. Create the pull request and select the owner as reviewer [maekind].
  4. You may merge the Pull Request in once you have the sign-off of the reviewer, or if you do not have permission to do that, you may request the owner to merge it for you.