Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
103 lines (72 loc) · 4.97 KB

CONTRIBUTING.md

File metadata and controls

103 lines (72 loc) · 4.97 KB

Introduction

Thank you for considering contributing to CCKProcessTracer. Your proposal doesn't necessarily have to be a significant change or add substantial value; even small corrections like typo fixes are greatly welcomed! This project continues to be a fantastic tool thanks to contributions from the developer community.

This contribution guideline is established to facilitate smooth communication centered around this project and to share an even better tool with the developer community. Following these guidelines shows respect for the developer community managing and developing this open-source project. In return, the developer community will also respect you. Please participate in contributing to CCKProcessTracer with these guidelines in mind.

There are various ways you can contribute to this project. Here are some main examples:

  • Writing and publishing tutorial articles or blog posts
  • Improving documentation through Pull Requests
  • Reporting bugs via GitHub issues
  • Requesting features or improvements through GitHub issues
  • Submitting pull requests for additional implementations

However, we do not accept contributions such as:

  • Posting support requests like how to use this tool in GitHub issues
  • Requesting features or improvements that do not align with the tool's purpose

If in doubt, please utilize the Creator Community on Discord .

Ground Rules

Here are the minimum rules to follow when contributing to CCKProcessTracer:

  • Read and adhere to the CODE_OF_CONDUCT
  • Before creating a new Issue, check if a similar Issue has been posted in the past
  • Follow the template when creating Issues and fill in the necessary items
  • Create Pull Requests from a fork of CCKProcessTracer in the ClusterVR namespace
  • Follow the template when creating Pull Requests and fill in the necessary items
  • Make Pull Requests as small as possible
  • If proposing a significant change, first suggest the overall concept, design, and approach in an Issue
  • Unless there is a specific reason, do not propose features that only work on a particular platform

Pull Requests

Basic steps for creating a Pull Request:

  1. Find the issue you want to solve in Pull Requests
  2. If there is no relevant issue, create a new one
  3. Fork CCKProcessTracer under the ClusterVR namespace
  4. Make the proposed changes in the fork
  5. Create a Pull Request from the feature branch of the fork to the develop branch of CCKProcessTracer in the ClusterVR namespace
  6. Follow the template and link the Issue when creating the Pull Request
  7. Discussions on the proposal will take place in the Issue or Pull Request
  8. Approval or rejection
  9. If the proposal is approved, the Pull Request will be merged by the maintainers of CCKProcessTracer, and the Issue will be closed
  10. If the proposal is rejected, both the Pull Request and Issue will be closed by the maintainers of CCKProcessTracer

For minor changes like spelling corrections that are likely to be merged, you can simplify the process as follows:

  1. Fork CCKProcessTracer under the ClusterVR namespace
  2. Make the proposed changes in the fork
  3. Create a Pull Request from the feature branch of the fork to the develop branch of CCKProcessTracer in the ClusterVR namespace
  4. The Pull Request will be merged by the maintainers of CCKProcessTracer

Bug Reporting

Basic steps for reporting a bug:

If you are about to report a security-related bug, do not create an Issue but contact devrel@cluster.mu directly.

Security-related bugs include:

  • Suspected access to other users' information
  • Suspected access to other users' creations

For regular bug reports, create an Issue by filling in the following items:

  • The version or revision you are using
  • The OS and CPU architecture of your runtime environment
  • The actions you were taking when the bug occurred
  • What behavior you were expecting originally
  • What the actual behavior was

If you're unsure whether it's a bug, first use the Creator Community on Discord .

Proposals

CCKProcessTracer aims to be a tool that visualizes complex CCK gimmicks and lowers the barrier to creating and sharing CCK gimmicks.

Basic steps for making new feature or specification change proposals:

  1. Check if the content you want to propose has already been discussed in past Issues
  2. If there is no relevant Issue, create a new one
  3. Fill in the Issue template
  4. Join the discussion

Code Reviews

Code reviews in CCKProcessTracer are conducted approximately once every 1-2 weeks by the core team or any member of the developer community. If the Pull Request is ready to be merged without feedback, it will be merged; otherwise, the reviewers will wait for the response of the Pull Request creator. If there is no response within about 3 weeks, the relevant Pull Request will be closed.

Community

CCKProcessTracer is supported by the developer community. Casual discussions and proposals might be easier in the Creator Community on Discord, so feel free to utilize it.