Fix more links and wording
This commit is contained in:
Zack Rauen
parent
80674c62d8
commit
61df13556a
|
|
@ -6,7 +6,7 @@ body:
|
|||
- type: checkboxes
|
||||
attributes:
|
||||
label: Before Reporting
|
||||
description: "I have double checked and asserted the following:"
|
||||
description: "I have double checked and agree with the following:"
|
||||
options:
|
||||
- label: I found no existing issues matching my bug
|
||||
required: true
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ body:
|
|||
- type: checkboxes
|
||||
attributes:
|
||||
label: Before Requesting
|
||||
description: "I have double checked and asserted the following:"
|
||||
description: "I have double checked and agree with the following:"
|
||||
options:
|
||||
- label: I found no existing issue matching my feature request
|
||||
required: true
|
||||
|
|
@ -20,8 +20,8 @@ body:
|
|||
attributes:
|
||||
label: Anything else?
|
||||
description: |
|
||||
Links? References? Anything that will give us more context about the feature request you are submitting!
|
||||
Links? References? Anything that will give us more context about the feature you are requesting!
|
||||
|
||||
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
|
||||
Tip: You can attach images by clicking this area to highlight it and then dragging files in.
|
||||
validations:
|
||||
required: false
|
||||
|
|
@ -1,12 +1,12 @@
|
|||
# Code of conduct
|
||||
# Code of Conduct
|
||||
|
||||
- We are committed to providing a friendly, safe and welcoming environment for all, regardless of level of experience, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, nationality, or other similar characteristic.
|
||||
- Please avoid using overtly sexual aliases or other nicknames that might detract from a friendly, safe and welcoming environment for all.
|
||||
- Please be kind and courteous. There’s no need to be mean or rude.
|
||||
- Respect that people have differences of opinion and that every design or implementation choice carries a trade-off and numerous costs. There is seldom a right answer.
|
||||
- Please keep unstructured critique to a minimum. If you have solid ideas you want to experiment with, make a fork and see how it works.
|
||||
- We will exclude you from interaction if you insult, demean or harass anyone. That is not welcome behavior. We interpret the term ""harassment" as including the definition in the [Citizen Code of Conduct](https://github.com/stumpsyn/policies/blob/master/citizen_code_of_conduct.md); if you have any lack of clarity about what might be included in that concept, please read their definition. In particular, we don’t tolerate behavior that excludes people in socially marginalized groups.
|
||||
- Private harassment is also unacceptable. No matter who you are, if you feel you have been or are being harassed or made uncomfortable by a community member, please contact one of the channel ops or any of the BetterDiscord staff immediately. Whether you’re a regular contributor or a newcomer, we care about making this community a safe place for you and we’ve got your back.
|
||||
- We will exclude you from interaction if you insult, demean or harass anyone. That is not welcome behavior. We interpret the term `harassment` as including the definition in the [Citizen Code of Conduct](https://github.com/stumpsyn/policies/blob/master/citizen_code_of_conduct.md); if you have any lack of clarity about what might be included in that concept, please read their definition. In particular, we don’t tolerate behavior that excludes people in socially marginalized groups.
|
||||
- Private harassment is also unacceptable. No matter who you are, if you feel you have been or are being harassed or made uncomfortable by a community member, please contact one of the channel ops or any of the [BetterDiscord staff](https://betterdiscord.app/invite) immediately. Whether you’re a regular contributor or a newcomer, we care about making this community a safe place for you and we’ve got your back.
|
||||
- Likewise any spamming, trolling, flaming, baiting or other attention-stealing behavior is not welcome.
|
||||
|
||||
This code of conduct is adapted from the [Rust Code of Conduct](https://www.rust-lang.org/policies/code-of-conduct).
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ The following is a set of guidelines for contributing to BetterDiscord. These ar
|
|||
|
||||
## Code of Conduct
|
||||
|
||||
See our [Code of Conduct](./CODE_OF_CONDUCT.md) page for details.
|
||||
See our [Code of Conduct](https://github.com/BetterDiscord/BetterDiscord/blob/main/CODE_OF_CONDUCT.md) page for details.
|
||||
|
||||
## What should I know before I get started?
|
||||
|
||||
|
|
@ -54,7 +54,7 @@ This is the main payload of BetterDiscord. This is what gets executed in the ren
|
|||
|
||||
This section guides you through submitting a bug report for BetterDiscord. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
|
||||
|
||||
Before creating bug reports, please check [this list](#before-submitting-a-bug-report) as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill out [the required template](https://github.com/BetterDiscord/BetterDiscord/blob/master/.github/ISSUE_TEMPLATE/bug-report.md), the information it asks for helps us resolve issues faster.
|
||||
Before creating bug reports, please check [this list](#before-submitting-a-bug-report) as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill out [the required template](https://github.com/BetterDiscord/BetterDiscord/blob/main/.github/ISSUE_TEMPLATE/BUG-REPORT.yml), the information it asks for helps us resolve issues faster.
|
||||
|
||||
> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
|
||||
|
||||
|
|
@ -66,7 +66,7 @@ Before creating bug reports, please check [this list](#before-submitting-a-bug-r
|
|||
|
||||
#### How Do I Submit A (Good) Bug Report?
|
||||
|
||||
Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). After you've determined this is a new bug using the steps from above, create an issue and provide the following information by filling in [the template](https://github.com/BetterDiscord/BetterDiscord/blob/master/.github/ISSUE_TEMPLATE/bug-report.md).
|
||||
Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). After you've determined this is a new bug using the steps from above, create an issue and provide the following information by filling in [the template](https://github.com/BetterDiscord/BetterDiscord/blob/main/.github/ISSUE_TEMPLATE/BUG-REPORT.yml).
|
||||
|
||||
Explain the problem and include additional details to help maintainers reproduce the problem:
|
||||
|
||||
|
|
@ -95,7 +95,7 @@ Include details about your configuration and environment:
|
|||
|
||||
This section guides you through submitting an enhancement suggestion for BetterDiscord, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.
|
||||
|
||||
Before creating enhancement suggestions, please check [this list](#before-submitting-an-enhancement-suggestion) as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Fill in [the template](https://github.com/BetterDiscord/BetterDiscord/blob/master/.github/ISSUE_TEMPLATE/feature_request.md), including the steps that you imagine you would take if the feature you're requesting existed.
|
||||
Before creating enhancement suggestions, please check [this list](#before-submitting-an-enhancement-suggestion) as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Fill in [the template](https://github.com/BetterDiscord/BetterDiscord/blob/main/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml), including the steps that you imagine you would take if the feature you're requesting existed.
|
||||
|
||||
#### Before Submitting An Enhancement Suggestion
|
||||
|
||||
|
|
@ -119,7 +119,7 @@ Unsure where to begin contributing? You can start by looking through `help-wante
|
|||
|
||||
#### Local development
|
||||
|
||||
BetterDiscord and the injector can be developed locally. First, clone the repo and run `npm install && npm run build-all` and locate the `dist` folder. Next you'll need to setup the injector to use your local files. In order to do this, you'll need to locate your local injector installation. Relative to your `Discord.exe` it would be in `./resources/app`. Modify the `./resources/app/betterdiscord/config.json` file and set `localPath` to the **absolute** path of your `dist` folder from before. Then for this to take effect, you'll need to fully restart Discord. Any future modifications to the remote app (`dist` folder) will be picked up on Discord reload.
|
||||
BetterDiscord can be developed and tested locally. First, clone the repo and run `pnpm install && pnpm build` this will generate a `dist` folder with compiled files. Next you'll need to inject your local setup to your desired release channel. There is a script in the repository to do this automatically for most cases. Just run `pnpm inject <channel>` where `<channel>` is the release channel--any of: stable, canary, ptb. Then for this to take effect, you'll need to fully restart Discord. Any future modifications to the renderer portion will be picked up on Discord reload. Preload and injector changes will require restarts.
|
||||
|
||||
### Pull Requests
|
||||
|
||||
|
|
@ -151,7 +151,7 @@ BetterDiscord supports a number of languages thanks to translations provided by
|
|||
|
||||
### JavaScript Styleguide
|
||||
|
||||
All JavaScript must adhere to the [ESLint rules](https://github.com/BetterDiscord/BetterDiscord/blob/master/.eslintrc) of the repo.
|
||||
All JavaScript must adhere to the [ESLint rules](https://github.com/BetterDiscord/BetterDiscord/blob/main/.eslintrc) of the repo.
|
||||
|
||||
Some other style related points not covered by ESLint:
|
||||
|
||||
|
|
@ -191,9 +191,9 @@ import {deepclone, isEmpty} from "./utilties"; // Avoid this
|
|||
|
||||
### CSS Styleguide
|
||||
|
||||
All CSS must adhere to the [Stylelint rules](https://github.com/BetterDiscord/BetterDiscord/blob/stable/.stylelintrc) of the repo.
|
||||
All CSS must adhere to the [Stylelint rules](https://github.com/BetterDiscord/BetterDiscord/blob/main/renderer/.stylelintrc) of the repo.
|
||||
|
||||
Some other style related points not covered by ESLint:
|
||||
Some other style related points not covered by StyleLint:
|
||||
|
||||
* Use verbose class names where applicable
|
||||
* Keep css files modular
|
||||
|
|
|
|||
Loading…
Reference in New Issue