Skip to content

Latest commit

 

History

History
81 lines (52 loc) · 3.51 KB

CONTRIBUTING.md

File metadata and controls

81 lines (52 loc) · 3.51 KB
Raw

Contributing to CityCoins

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to CityCoins and its packages, which are hosted in the CityCoins Organization on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

You do not need anyone’s permission to get involved and contribute to the initiative.

Code of Conduct

This project and everyone participating in it is governed by the CityCoins Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior on the CityCoins Discord.

Submitting an Issue

GitHub issues are the main way to track bugs, enhancements, and other changes to the software.

To submit an issue, click on the "Issues" tab in the related repository and fill in as much information as possible.

Some repositories may have templates to help guide you during the process.

Reporting a Bug

When reporting a bug, try to include as much detail as possible, including but not limited to:

  • Description of the bug
  • Steps to reproduce the bug
  • Actual vs expected results
  • Screenshots (if applicable)

Requesting an Enhancement

When requesting a new feature, try to include as much detail as possible, including but not limited to:

  • Description of the feature
  • Is the feature related to a problem?
  • Description of the solution

Starting a Discussion

GitHub Discussions are a way to have longer-form conversations about a specific topic.

To create a new discussion, click on the "Discussions" tab in the related repository and fill in as much information as possible (if enabled).

Submitting a Pull Request

GitHub Pull Requests are a way to submit changes to the code.

Changes are made in a separate branch or repository, and are then submitted to the main repository.

Repository maintainers can review the changes and approve them.

Standard Workflow

  1. Fork the repository
  2. Clone your version of the repository
  3. Create a new branch related to the PR: git checkout -b my-branch-name
  4. Make changes and push them to your version of the repository
  5. Create a pull request and include details for reviewers

Resources

Community Links