Skip to content

Missing CONTRIBUTING.md and CODE_OF_CONDUCT.md file referenced in README #164

@hi2242

Description

@hi2242

Explain

The README.md file includes a hyperlink pointing to CONTRIBUTING.md to guide potential contributors. However, the CONTRIBUTING.md file does not currently exist in the repository. As a result, clicking the link leads to a 404 Page Not Found error.

Steps to Reproduce Problem

  1. Navigate to the main page of the repository (README.md).
  2. Locate the link referring to the contribution guide (e.g., CONTRIBUTING.md).
  3. Click on the link.
  4. Observe that a 404 error page is displayed.

Screenshots

Image

Proposed Solution

I have already prepared the CONTRIBUTING.md content, referencing other active repositories within the Toss organization. Please check the draft below:

Click to view the proposed CONTRIBUTING.md

Contributing to Granite Framework

Welcome contribution from everyone

All communications in this repository will be by English.

Every contributor to Granite Framework should adhere to our Code of Conduct. Please read it to understand what actions will and will not be tolerated.

Contributing as issue

1. Search for duplicates

Search the existing issues before logging a new one.

2. Found a bug?

When logging a bug, please be sure to include the following:

  • What version of TypeScript you're using (run tsc --v)
  • If at all possible, an isolated way to reproduce the behavior
  • The behavior you expect to see, and the actual behavior

3. Feature suggestion?

We also accept suggestions in the issue tracker.

In general, things we find useful when reviewing suggestions are:

  • A description of the problem you're trying to solve
  • An overview of the suggested solution

Contributing as code

Prerequisites

  1. Choose an issue about bug or feature you want to work on

  2. Fork this repository.

  3. Clone the repository

    git clone [email protected]:{username}/granite.git
  4. Please use the correct node version. You can use the version declared in .nvmrc. We strongly recommend nvm to control local machine's node version easily. also We recommend nvm's deeper shell integration too.

  5. Install packages. We use [email protected]. Please install Yarn (preferably via corepack) if you can. We recommend using corepack to automatically use the version declared in the packageManager field of package.json.

    corepack enable && corepack prepare
    yarn install

Pull Requests

Opening a pull request

All commit message and title of your Pull Request should match the following format:

<type>[optional package scope]: <description>

[optional body]

[optional footer(s)]

We adhere Conventional Commits.

Several predefined GitHub Workflows will check qualities. If you fail our checks, please check the error message and update the Pull Request.

Click to view the proposed CODE_OF_CONDUCT.md (Extra File for CONTRIBUTING.md)

Contributor Covenant Code of Conduct

Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

  • Demonstrating empathy and kindness toward other people
  • Being respectful of differing opinions, viewpoints, and experiences
  • Giving and gracefully accepting constructive feedback
  • Accepting responsibility and apologizing to those affected by our mistakes,
    and learning from the experience
  • Focusing on what is best not just for us as individuals, but for the overall
    community

Examples of unacceptable behavior include:

  • 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
  • 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 and 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
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
Here is email blank.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

1. Correction

Community Impact: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

Consequence: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

2. Warning

Community Impact: A violation through a single incident or series of
actions.

Consequence: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

3. Temporary Ban

Community Impact: A serious violation of community standards, including
sustained inappropriate behavior.

Consequence: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

4. Permanent Ban

Community Impact: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

Consequence: A permanent ban from any sort of public interaction within the
community.

Attribution

This Code of Conduct is adapted from the Contributor Covenant,
version 2.1, available at
https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.

Community Impact Guidelines were inspired by
Mozilla's code of conduct enforcement ladder.

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.

If this looks acceptable, could you please assign this issue to me? Also, please provide the community leader's email address (ending in @toss.im) to be included in CODE_OF_CONDUCT.md. I am ready to submit a Pull Request immediately.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions