-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
41046d3
commit abce385
Showing
1 changed file
with
28 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| # Contributing | ||
|
|
||
| Thank you for your interest in improving this tool. This app is only built with HTML, CSS and JavaScript, so contributing should be very beginner-friendly. | ||
| To find out what issues you can potentially work on right away, please go to the issues tab [here](https://github.com/arbolitoloco/color-blind-simulator/issues). | ||
|
|
||
| ## Project Kanban Board | ||
|
|
||
| If you don't know where to start, please check the [project kanban board](https://github.com/arbolitoloco/color-blind-simulator/projects/1) to see todos, issues and ideas. | ||
|
|
||
| ## Suggested improvements | ||
|
|
||
| Currently I'm planning on making improvements that can be grouped in the following general areas: | ||
|
|
||
| - Localization: It would be great to have the app translated to other languages. | ||
| - Context: Ideally the app would have a bit more of information on color deficiencies and how to design visuals with acessibility in mind, with links to useful resources. | ||
| - Testing: I haven't had a lot of people test this tool, so testing and opening bug reports would be extremely useful. | ||
| - Design: I'm open to restyling the app to make it easier on the eyes and maybe also more user-friendly (styling the download button is what first comes to mind). Right now I'm not using any frameworks, it's purely CSS (with some destyling to reset things). The app uses CSS Grid for the layout. | ||
| - Features: Ideally the app will include an additional page to add the Context item (information and related links), so that link would have to be included in the header in a menu that is mobile-friendly as well. | ||
|
|
||
| ## Making modifications | ||
|
|
||
| To propose changes to the project, you should fork this repository, and open a pull request once you're satisfied with your changes. | ||
|
|
||
| Modifications should not be made to dependencies (`css/destyle.css` and `js/html2canvas.min.js`), unless you're updating their versions. | ||
|
|
||
| More information on how to fork a repo [here](https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/fork-a-repo) and on pull requests [here](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/about-pull-requests). | ||
|
|
||
| [This nifty guide](https://dev.to/getting-started-with-hacktoberfest) might help you if you're a first time contributor. |