Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (34 loc) · 2.96 KB

CONTRIBUTING.md

File metadata and controls

55 lines (34 loc) · 2.96 KB

Contributing to PixelAlchemy Studio

First off, thank you for considering contributing to PixelAlchemy Studio! It's people like you that make PixelAlchemy Studio such a great tool.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

How Can I Contribute?

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 PixelAlchemy Studio itself.

Reporting Bugs

If you find a bug, please ensure the bug was not already reported by searching on GitHub under Issues.

If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

If you have an idea for a new feature or an improvement to an existing one, please open an issue on GitHub. Clearly describe the proposed enhancement, why it would be beneficial, and any potential implementation ideas.

Pull Requests

If you have a bug fix or new feature that you would like to contribute, please submit a pull request. Ensure the following:

  1. Fork the repository and create your branch from main.
  2. Set up your development environment as described in the README.md.
  3. Make your changes in your forked repository.
  4. Add tests for your changes. This is important so we don't break it in a future version.
  5. Ensure your code lints.
  6. Write a clear and concise commit message.
  7. Push your changes to your fork.
  8. Open a pull request to the main branch of the original repository.
  9. Clearly describe your changes in the pull request description.

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.

Python Styleguide

All Python code must adhere to PEP 8 -- Style Guide for Python Code.

Code of Conduct

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

Questions?

If you have any questions, feel free to reach out by opening an issue.