Skip to content

Commit

Permalink
docs: imporovement (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
haloivanid authored Nov 24, 2024
1 parent adf4e97 commit 6bcebbd
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 20 deletions.
27 changes: 13 additions & 14 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,14 @@ The following behaviors contribute to a positive environment for our community:
- The use of sexualized language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address, without their explicit permission
Permission:
Other conduct which could reasonably be considered inappropriate in a professional setting
Enforcement Responsibilities:
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior. They will take
appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening,
offensive, or harmful.
- Publishing others' private information, such as a physical or email address, without their explicit permission.
> Permission:
> Other conduct which could reasonably be considered inappropriate in a professional setting
> Enforcement Responsibilities:
> Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior. They will take
> appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening,
> offensive, or harmful.
Community leaders have the right and responsibility to remove, edit, or reject any comments, commits, code, wiki edits,
issues, or other contributions that are not aligned with this Code of Conduct. They will communicate reasons for
Expand All @@ -42,7 +43,7 @@ account, or act as an appointed representative at an online or offline event.
## Enforcement

If you witness or experience any form of abusive, harassing, or unacceptable behavior, you are encouraged to report it
to the community leaders responsible for enforcement at [INSERT CONTACT METHOD].
to the community leaders responsible for enforcement at <[email protected]>.
All complaints will be reviewed and investigated promptly and fairly.

Community leaders must respect the privacy and security of the reporter of any incident.
Expand All @@ -55,8 +56,7 @@ Community leaders must follow these guidelines when determining consequences for
### 1. Correction

**Community Impact**: Use of inappropriate language or other unprofessional or unwelcome behavior in the community will
not
be tolerated.
not be tolerated.

**The consequence will be**: Community leaders will issue a written warning to the offending party, clearly defining the
nature of the violation and explaining why the behavior was inappropriate. A public apology will be requested.
Expand All @@ -78,10 +78,9 @@ social media. If you violate these terms, you will face a temporary or permanent
result in immediate and permanent banning from the community.

**The consequence is as follows**: You will be temporarily banned from any form of interaction or public communication
with
the community for a specified period of time. During this period, you are not permitted to interact with anyone involved
in this process, including those enforcing the Code of Conduct. This includes any unsolicited interaction.
If you violate these terms, you will be permanently banned.
with the community for a specified period of time. During this period, you are not permitted to interact with anyone
involved in this process, including those enforcing the Code of Conduct. This includes any unsolicited interaction. If
you violate these terms, you will be permanently banned.

If you engage in any of the following activities, you will be permanently banned from the community: A permanent ban
will result in the following community impact: If you demonstrate a pattern of violating community standards, including
Expand Down
15 changes: 9 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ can't wait to see what you contribute! 🎉
## Code of Conduct

This project and everyone participating in it is governed by the
[Code of Conduct](blob/master/CODE_OF_CONDUCT.md).
[Code of Conduct](/CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code. Please report unacceptable behavior
to <[email protected]>.

Expand All @@ -38,12 +38,13 @@ to <[email protected]>.
> If you want to ask a question, we assume that you have read the available [Documentation](/README.md).
We've made it easy for you to find the answers you're looking for! Before you ask a question, simply search for existing
[Issues](/issues) that might help you. If you've found a suitable issue and still need clarification, you can write your
[Issues](https://github.com/Tulungagung-Developer/finote/issues) that might help you. If you've found a suitable issue
and still need clarification, you can write your
question in this issue. And don't forget to search the internet for answers first!

If you then still feel the need to ask a question and need clarification, we recommend the following:

- Open an [Issue](/issues/new).
- Open an [Issue](https://github.com/Tulungagung-Developer/finote/issues/new).
- Provide as much context as you can about what you're running into.
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.

Expand Down Expand Up @@ -85,7 +86,8 @@ possible!
We use GitHub issues to track bugs and errors. If you run into an issue with the project:

- Please create a new issue by clicking on the [Issue](/issues/new). As we are not yet certain whether this is a bug, we
- Please create a new issue by clicking on the [Issue](https://github.com/Tulungagung-Developer/finote/issues/new). As
we are not yet certain whether this is a bug, we
kindly request that you refrain from discussing it and from labeling the issue.
- Please describe the expected behavior and the actual behavior.
- Please provide as much context as possible and describe the steps that someone else can follow to recreate the issue
Expand All @@ -112,15 +114,16 @@ understand your suggestion and find related suggestions.
- Just a heads-up: Make sure you're using the latest version.
- Take a look at the documentation [README](/README.md) and see if the functionality is already covered, maybe by an
individual configuration.
- Check if the enhancement has already been suggested by doing a search [Issues](/issues). If it's already been
- Check if the enhancement has already been suggested by doing a
search [Issues](https://github.com/Tulungagung-Developer/finote/issues). If it's already been
suggested, just add a comment to the existing issue instead of opening a new one.
- Make sure your idea fits with the project's scope and aims. It's up to you to make a strong case to convince the
developers of the feature's merits. Keep in mind that we want features that will be useful to most of our users, not
just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.

#### How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as [GitHub issues](/issues).
Enhancement suggestions are tracked as [GitHub issues](https://github.com/Tulungagung-Developer/finote/issues).

- Use a **clear and descriptive title** for the issue to identify the suggestion.
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
Expand Down

0 comments on commit 6bcebbd

Please sign in to comment.