Skip to content
This repository has been archived by the owner on Jun 16, 2022. It is now read-only.

Latest commit

 

History

History
27 lines (17 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

27 lines (17 loc) · 1.56 KB

Contributing to Year In Pixels

Our main responsibility is to be up to date with used technologies, keep core features of Year-In-Pixels and don't add tailored ones for specific users.

All efforts to contribute are highly appreciated, we recommend you talk to a maintainer prior to spending a lot of time making a pull request that may not align with the project roadmap.

Submitting a Pull Request

Good pull requests, such as patches, improvements, and new features, are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Please ask first if somebody else is already working on this or the core developers think your feature is in-scope for Year-In-Pixels. Generally always have a related issue with discussions for whatever you are including.

Development Workflow

  1. Clone the repo with git clone https://github.com/lPaths/year-in-pixels.git
  2. Run yarn in the root folder to install dependencies.
  3. and then run yarn start

Reporting an issue

Before submitting an issue you need to make sure:

  • You have already searched for related issues, and found none open (if you found a related closed issue, please link to it from your post).
  • Your issue title is concise and on-topic.
  • You can and do provide steps to reproduce your issue.
  • Make sure the issue template is respected.
  • Make sure your issue body is readable and well formated.