Skip to content

Commit

Permalink
docs: spring cleaning
Browse files Browse the repository at this point in the history
  • Loading branch information
insertish committed Mar 15, 2024
1 parent 868e07b commit 57fbf07
Show file tree
Hide file tree
Showing 10 changed files with 98 additions and 80 deletions.
10 changes: 3 additions & 7 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
## Code of Conduct

This is adapted from the Revolt Lounge.

1. Please be kind to one another, remember the human.
2. (Not applicable to GitHub.)
3. Trolling, flaming, baiting or other attention-stealing behaviour is not welcome.
4. Racism, homophobia, or otherwise demeaning a group of people is not allowed, this is an inclusive space and we ask that you respect this.

These rules only apply to the Revolt Testers server and any public communication with the team, such as GitHub discussions or issues. Communities may apply these rules to their own servers.
2. Spam and unsolicited advertisements are not permitted.
3. Trolling, flaming, baiting or other attention-stealing behaviour is not allowed.
4. Discrimination or otherwise demeaning a group of people is not permitted, this is an inclusive space and we ask that you respect this.
39 changes: 16 additions & 23 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,3 @@
> # Client Refactoring!
> Revite is currently being deprecated and replaced with a Solid.js client, for more information see https://github.com/revoltchat/revoltchat-solid-client-monorepo/issues/14 with information on how to contribute for the time being.
# Finding Issues

You can find issues using the main project board, here are some categories you should look at in-order:
1. If you are new to the code base or are looking for issues we really need help with, look at ["What can I help with?"](https://github.com/orgs/revoltchat/projects/3/views/11)
2. Issue Board ["Free Issues"](https://github.com/orgs/revoltchat/projects/3/views/1): issues that anyone can pick up and are generally free to work on.
3. Issue Board ["Todo"](https://github.com/orgs/revoltchat/projects/3/views/1): these are issues that are probably fine to pick up, but please ask first since a lot of these tend to be complicated and potentially already planned.
4. Working on new issues and fixes: ideally you should run new features by us, most fixes are probably going to be alright though, we wouldn't want to reject any PRs that we don't deem suitable after work has already been done. If it's a fix, make sure to make an issue for it first, if it's a new feature, it may be better suited in [Feature Suggestions](https://github.com/revoltchat/revolt/discussions/categories/feature-suggestions).

Any issues marked with "Future Work" or with a milestone greater than the current milestone are out of bounds and should not be worked on since it's likely that the team already has a plan in place, any work you may do may conflict with prior ideas, and your work may potentially be rejected if it does fit the criteria exactly. In general, these issues are just postponed to reduce long term technical debt, i.e. allow current issues to be handled.

# Working on Issues

Be sure to:
- Follow the contributing guidelines below.
- Notify us when you're working on an issue, either by leaving a comment (you don't necessarily need to be assigned to an issue) or if you forget, be sure to link your PR back to the original issue by including "Fixes \#1" in your PR to ensure we keep track of this stuff.

# Contributing

- Commit using [Conventional Commit style](https://www.conventionalcommits.org/en/v1.0.0-beta.2/).
Expand All @@ -27,21 +8,33 @@ Be sure to:

### Contributing Source Translations

> [!IMPORTANT]
> For any other language, always use [Weblate](https://translate.revolt.chat)!
You may have to add or modify source translations to achieve something in the client, to modify source translations:

- PR your translations to the [translations repository](https://github.com/revoltchat/translations).
- Use these translations in your local client, but do not commit changes to the `external/locale` submodule as to avoid conflicts with other PRs.
- Language definitions will be updated accordingly after merge.

# Merging Pull Requests

To keep commit history nice and tidy, always use [Conventional Commit style](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) for any merge commit messages. And where possible:

1. `Squash and Merge` for bug fixes / small features, especially if the fix has multiple iterations, [example](https://github.com/revoltchat/revite/pull/492), or if the commits don't follow conventional commit style.

Beyond this point you should usually check with a maintainer on how to merge, (drop a message in the "Ready to merge" channel), and should only proceed with the following if the commits follow [Conventional Commit style](https://www.conventionalcommits.org/en/v1.0.0-beta.2/):
Beyond this point you should usually check with a maintainer on how to merge, and should only proceed with the following if the commits follow [Conventional Commit style](https://www.conventionalcommits.org/en/v1.0.0-beta.2/):

2. Prefer to `Rebase and Merge` where possible.
3. Create a merge request with commit message similar to `chore: merge something from x (#1)`.
3. Create a merge request with commit message similar to `merge: remote-tracking branch abc into xyz (#1)`.

# What can I help with?

# Triage
The main project board can serve as a helpful starting point:

If you are part of the triage team, or are interested in triage, the [full guide is available here](https://github.com/orgs/revoltchat/teams/triage-team/discussions/1).
1. If you are new to the code base or are looking for issues we really need help with, look at ["What can I help with?"](https://github.com/orgs/revoltchat/projects/3/views/11)
2. Issue Board ["Free Issues"](https://github.com/orgs/revoltchat/projects/3/views/1): issues that anyone can pick up and are generally free to work on
3. Issue Board ["Todo"](https://github.com/orgs/revoltchat/projects/3/views/1): these are issues that are probably fine to pick up, but please ask first since a lot of these tend to be complicated and potentially already planned
4. Working on new issues and fixes: ideally you should run new features by us, most fixes are probably going to be alright though, we wouldn't want to reject any PRs that we don't deem suitable after work has already been done. If it's a fix, make sure to make an issue for it first, if it's a new feature, it may be better suited in [Feature Suggestions](https://github.com/revoltchat/revolt/discussions/categories/feature-suggestions)

Any issues marked with "Future Work" or with a milestone greater than the current milestone are out of bounds and should not be worked on since it's likely that the team already has a plan in place, any work you may do may conflict with prior ideas, and your work may potentially be rejected if it does fit the criteria exactly. In general, these issues are just postponed to reduce long term technical debt, i.e. allow current issues to be handled.
29 changes: 15 additions & 14 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,28 +7,29 @@ Before reporting a vulnerability, please make sure it is in scope, for example y
- Server vulnerabilities that may escalate user privileges or allow exfiltration of data.
- Client vulnerabilities that allow remote code execution or allow exfiltration of data.

You should not report anything that requires phyiscal access to a client machine to achieve, such as:
You should not report anything that requires physical access to a client machine to achieve, such as:

- Intercepting requests to visually affect client privilege (and not actual server privilege)
- Exfiltration of user credentials through third party sites

If you would like to report a security vulnerability,
please email **[[email protected]](mailto:[email protected])**,
this will open a new ticket in ticket system, you should receive a response
within the next couple of days, potentially within a few minutes if someone
is currently active.
You may disclose security vulnerabilities to us in two different ways:

To help us best triage the issue, please provide:
- Create a draft security advisory on the appropriate GitHub repository on [our organisation](https://github.com/revoltchat).

You can select the "Security" tab once on the repository then fill out the details as appropriate.

- Email us at [[email protected]](mailto:[email protected]) to open a new ticket.

You should receive a response within the next couple of days.

In general, please always provide:

- The type of issue at hand
- The name of the relevant project affected
- The name of the relevant project(s) affected
- Reproduction steps
- Reference to any relevant source file(s) that you may suspect are causing the issue
- Any extra information about your configuration.
- Reference to any relevant source file(s) that you may suspect are causing the issue (if you can)
- Any extra information about your configuration
- Description of potential ways this can be exploited, if you can list any

For revoltchat/revite in particular:

- Please include the commit hash of the client, it is visible in settings under the log out button.
- Any version information (e.g. commit hash for web client, API version, etc)

Thank you for helping Revolt.
5 changes: 2 additions & 3 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
## Please make sure to check the following tasks before opening and submitting a PR

* [ ] I understand and have followed the [contribution guide](https://github.com/revoltchat/revolt/discussions/282)
* [ ] I have tested my changes locally and they are working as intended
* [ ] These changes do not have any notable side effects on other Revolt projects
- [ ] I understand and have followed the [contribution guide](https://github.com/revoltchat/.github/blob/master/.github/CONTRIBUTING.md)
- [ ] I have tested my changes locally and they are working as intended
Loading

0 comments on commit 57fbf07

Please sign in to comment.