From e466bfc2d54bdbb8e1e3e57904f28451c6cc7aa4 Mon Sep 17 00:00:00 2001 From: alstjr7375 Date: Sat, 9 Apr 2022 21:56:27 +0900 Subject: [PATCH] Doc: Separated `docs/README.md` --- CONTRIBUTING.md | 86 +++++++++++++++---------------------------------- docs/README.md | 52 ++++++++++++++++++++++++++++++ docs/Rules.md | 4 +++ 3 files changed, 82 insertions(+), 60 deletions(-) create mode 100644 docs/README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ba7d536..bc03685 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,13 +4,11 @@ **Table of Contents** - [Introduce](#introduce) - - [Code of Conduct](#code-of-conduct) - - [We Develop with Github](#we-develop-with-github) - - [Environment](#environment) - - [Your First Contribution](#your-first-contribution) - - [Contribution Targets](#contribution-targets) - - [Project Structure](#project-structure) - - [Restrictions](#restrictions) + * [Code of Conduct](#code-of-conduct) + * [We Develop with Github](#we-develop-with-github) + * [Environment](#environment) + * [Your First Contribution](#your-first-contribution) + * [Contribution Targets](#contribution-targets) - [Rules](#rules) - [License](#license) - [References](#references) @@ -71,36 +69,34 @@ yarn validate ### Your First Contribution -**Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) +**Working on your first Pull Request?** -The following documents may be helpful: -- [Roadmap](https://github.com/black7375/Firefox-UI-Fix/issues/2) -- [Each Versions Plan](https://github.com/black7375/Firefox-UI-Fix/milestones) -- [Wiki:Compatibility Issues Solution](https://github.com/black7375/Firefox-UI-Fix/wiki/Compatibility-Issues-Solution) -- [Wiki:Tips](https://github.com/black7375/Firefox-UI-Fix/wiki/Tips) +You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) -CSS, SASS Documents: -- [CSS](https://developer.mozilla.org/en-US/docs/Web/CSS) -- [SASS(SCSS)](https://sass-lang.com/documentation) -- [SASS Live Compile](https://www.sassmeister.com/) - -Live Debugging: -- [Tutorial: How to create and live-debug userChrome.css](https://www.reddit.com/r/FirefoxCSS/comments/73dvty/tutorial_how_to_create_and_livedebug_userchromecss/) -- [Browser Toolbox](https://developer.mozilla.org/en-US/docs/Tools/Browser_Toolbox) -- [Style Editor](https://developer.mozilla.org/en-US/docs/Tools/Style_Editor) - -Firefox Source Code: -- [Github](https://github.com/mozilla/gecko-dev) -- [Searchfox](https://searchfox.org/) -- [Firefox Source Docs](https://firefox-source-docs.mozilla.org/) - -Test for None mac users: -- [Docker-OSX](https://github.com/sickcodes/Docker-OSX) +And, Please refer to the [development documentation](./docs/). ### Contribution Targets We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: +**Codes** +- New Features. +- Bug fixes. +- Improved compatibility or accessibility. +- Refactoring. + +**Issues** +- Report a bug. +- Discussing the current state of the code. +- Tell us about related or relevant projects and documents. +- Help other users issue. +- Proposing others.. + +**Docs** +- Fix typos, alignments. +- Correct awkward sentences. +- Improve document readability. + **Promotions** - Introduce project - Video (Recommend!!, We need it) @@ -111,36 +107,6 @@ We love your input! We want to make contributing to this project as easy and tra - [Producthunt](https://www.producthunt.com/posts/firefox-ui-fix-proton)([#43](https://github.com/black7375/Firefox-UI-Fix/issues/43)) - [Youtube](https://www.youtube.com/watch?v=ECta0icNMgY) -**Docs** -- Fix typos, alignments. -- Correct awkward sentences. -- Improve document readability. - -**Issues** -- Report a bug. -- Discussing the current state of the code. -- Tell us about related or relevant projects and documents. -- Help other users issue. -- Proposing others.. - -**Codes** -- New Features. -- Bug fixes. -- Improved compatibility or accessibility. -- Refactoring. - -### Project Structure - -Refer to [Project\_Structure.md](./docs/Project_Structure.md). - -### Restrictions - -Refer to [Restrictions.md](./docs/Restrictions.md). - -## Rules - -Refer to [Rules.md](./docs/Rules.md). - ## License **Any contributions you make will be under the MPL 2.0 Software License** diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..1430e4b --- /dev/null +++ b/docs/README.md @@ -0,0 +1,52 @@ +# Develper Documents + + +**Table of Contents** + +- [Basics](#basics) +- [Project-Specific](#project-specific) + * [Project Structure](#project-structure) + * [Rules](#rules) +- [User Custom CSS](#user-custom-css) + * [Restrictions](#restrictions) + + + + +## Basics +The following documents may be helpful: +- [Roadmap](https://github.com/black7375/Firefox-UI-Fix/issues/2) +- [Each Versions Plan](https://github.com/black7375/Firefox-UI-Fix/milestones) +- [Wiki:Compatibility Issues Solution](https://github.com/black7375/Firefox-UI-Fix/wiki/Compatibility-Issues-Solution) +- [Wiki:Tips](https://github.com/black7375/Firefox-UI-Fix/wiki/Tips) + +CSS, SASS Documents: +- [CSS](https://developer.mozilla.org/en-US/docs/Web/CSS) +- [SASS(SCSS)](https://sass-lang.com/documentation) +- [SASS Live Compile](https://www.sassmeister.com/) + +Live Debugging: +- [Tutorial: How to create and live-debug userChrome.css](https://www.reddit.com/r/FirefoxCSS/comments/73dvty/tutorial_how_to_create_and_livedebug_userchromecss/) +- [Browser Toolbox](https://developer.mozilla.org/en-US/docs/Tools/Browser_Toolbox) +- [Style Editor](https://developer.mozilla.org/en-US/docs/Tools/Style_Editor) + +Firefox Source Code: +- [Github](https://github.com/mozilla/gecko-dev) +- [Searchfox](https://searchfox.org/) +- [Firefox Source Docs](https://firefox-source-docs.mozilla.org/) + +Test for None mac users: +- [Docker-OSX](https://github.com/sickcodes/Docker-OSX) + +## Project-Specific +### Project Structure +- [Project\_Structure.md](./Project_Structure.md). + +### Rules +This is a rough guideline. (Not forced) + +- [Rules.md](./Rules.md). + +## User Custom CSS +### Restrictions +- [Restrictions.md](./Restrictions.md). diff --git a/docs/Rules.md b/docs/Rules.md index d3d4074..a1cc771 100644 --- a/docs/Rules.md +++ b/docs/Rules.md @@ -18,6 +18,10 @@ ## Basics +This is a rough guideline. (Not forced) + +Feel free to make PR. + ### Issue **Search:**