Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nielsfaber authored Mar 26, 2024
1 parent f37290c commit b530f3d
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Contributing

Thank you for your interest in contributing to this project!
You can contribute to this project by submitting a PR with your changes.
Note that it may take between 1-4 weeks before your work can be reviewed and approved.

## Building

Expand All @@ -13,8 +15,17 @@ Thank you for your interest in contributing to this project!
* `npm start` # To develop interactively
* `npm run build` # Run lint, prettier, rollup (update 'dist/scheduler-card.js')

## Submitting new translations

## Codebase rewrite
If you would like to add a translation of the card in your native language, you can take the [english translation file](https://github.com/nielsfaber/scheduler-card/blob/main/src/localize/languages/en.json) as starting point and replace the texts on the right side of each line with local translation. Words within {curly brackets} should not be translated.
Note that a translation file should be complete before it can be accepted as PR.

## Submitting new features

If you wish to implement a new feature for this project, please first create a feature request to explain your idea and for further discussion/alignment.
This avoids the risk of spending effort on code which may not be adopted by the project.

## Warning!

Please note that a major rewrite of the codebase is ongoing as of March 2024. If you are
planning on submitting a significant contribution, get in touch to request a branch for
Expand Down

0 comments on commit b530f3d

Please sign in to comment.