mirror of
https://github.com/BetterSEQTA/BetterSEQTA-Plus.git
synced 2026-06-05 19:24:39 +00:00
update contributing md
This commit is contained in:
@@ -5,7 +5,13 @@
|
|||||||
Forking the BetterSEQTA project to add extra functionality
|
Forking the BetterSEQTA project to add extra functionality
|
||||||
Looking for contributors!
|
Looking for contributors!
|
||||||
|
|
||||||
## Key Features
|
## Table of contents
|
||||||
|
- [Features](#features)
|
||||||
|
- [Getting Started](#getting-started)
|
||||||
|
- [Contributing](#contributing)
|
||||||
|
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
* Dark mode
|
* Dark mode
|
||||||
- Custom Background
|
- Custom Background
|
||||||
@@ -22,7 +28,35 @@ Looking for contributors!
|
|||||||
- Edge Supported
|
- Edge Supported
|
||||||
- Brave Supported
|
- Brave Supported
|
||||||
- (kinda) Opera Supported (We have found a issue that the manifest V3 version doesn't work on Opera, Please use Ultra Stable (3.0.2)
|
- (kinda) Opera Supported (We have found a issue that the manifest V3 version doesn't work on Opera, Please use Ultra Stable (3.0.2)
|
||||||
|
|
||||||
|
## Getting started
|
||||||
|
|
||||||
|
1. Clone the repository
|
||||||
|
```
|
||||||
|
git clone https://github.com/SethBurkart123/BetterThanBetterSeqta
|
||||||
|
```
|
||||||
|
2. Install dependencies
|
||||||
|
```
|
||||||
|
npm install
|
||||||
|
```
|
||||||
|
3. Run the dev script (it updates as you save files)
|
||||||
|
```
|
||||||
|
npm run dev
|
||||||
|
```
|
||||||
|
|
||||||
|
## Folder Structure
|
||||||
|
|
||||||
|
The folder structure is as follows:
|
||||||
|
|
||||||
|
- The `public` folder contains files that are not compiled, but only copied across to the build directory
|
||||||
|
|
||||||
|
- The `src` folder contains source files that are compiled to the build directory, these can use import statements so that we can do code splitting.
|
||||||
|
|
||||||
|
- The `build` folder is where the compiled code ends up, this is the folder what you need to load into chrome as an unpacked extension for development.
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
If you would like to contribute to this project, please read the [contributing guidelines](CONTRIBUTING.md).
|
||||||
|
|
||||||
## Credits
|
## Credits
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,46 @@
|
|||||||
|
# Contributing
|
||||||
|
|
||||||
|
When contributing to this repository, please first discuss the change you wish to make via issue,
|
||||||
|
email, or any other method with the owners of this repository before making a change.
|
||||||
|
|
||||||
|
Please note we have a code of conduct, please follow it in all your interactions with the project.
|
||||||
|
|
||||||
|
## Pull Request Process
|
||||||
|
|
||||||
|
1. It is recommended to start by opening an issue to discuss the change you wish to make. This will allow us to discuss the change and ensure it is a good fit for the project.
|
||||||
|
2. Fork the repo and create your branch from `master`.
|
||||||
|
3. When writing your pull request, make sure to use the pull request template.
|
||||||
|
|
||||||
|
### Pull Request Template
|
||||||
|
|
||||||
|
```
|
||||||
|
## Description
|
||||||
|
|
||||||
|
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
|
||||||
|
|
||||||
|
Fixes # (issue)
|
||||||
|
|
||||||
|
## Type of change
|
||||||
|
|
||||||
|
Please delete options that are not relevant.
|
||||||
|
|
||||||
|
- [ ] Bug fix (non-breaking change which fixes an issue)
|
||||||
|
- [ ] New feature (non-breaking change which adds functionality)
|
||||||
|
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
|
||||||
|
- [ ] This change requires a documentation update
|
||||||
|
|
||||||
|
## How Has This Been Tested?
|
||||||
|
|
||||||
|
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
### Issues
|
||||||
|
|
||||||
|
#### Create a new issue
|
||||||
|
|
||||||
|
If you spot a problem with the readme or code, [search if an issue already exists](https://github.com/SethBurkart123/BetterThanBetterSeqta/issues). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/SethBurkart123/BetterThanBetterSeqta/issues/new).
|
||||||
|
|
||||||
|
#### Solve an issue
|
||||||
|
|
||||||
|
Scan through our [existing issues](https://github.com/SethBurkart123/BetterThanBetterSeqta/issues) to find one that interests you. You can narrow down the search using `labels` as filters. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
|
||||||
@@ -10,7 +10,6 @@
|
|||||||
|
|
||||||
// You should have received a copy of the GNU General Public License
|
// You should have received a copy of the GNU General Public License
|
||||||
// along with this program. If not, see <https://www.gnu.org/licenses/>. */
|
// along with this program. If not, see <https://www.gnu.org/licenses/>. */
|
||||||
@import url('https://fonts.googleapis.com/css?family=Rubik:300,400,500,600');
|
|
||||||
/* // This program is free software: you can redistribute it and/or modify
|
/* // This program is free software: you can redistribute it and/or modify
|
||||||
// it under the terms of the GNU General Public License as published by
|
// it under the terms of the GNU General Public License as published by
|
||||||
// the Free Software Foundation, either version 3 of the License, or
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
|||||||
Reference in New Issue
Block a user