Welcome to Citizen of Arcanis, a fully on-chain MMORPG set in a vast cyberpunk universe where players control everything — from the economy to combat and survival. This repository contains the Cairo Backend for the game.
We deeply appreciate your interest in contributing to the Citizen of Arcanis project! Below are the steps to help you get started effectively. Join our contributors' community by connecting with us on Telegram.
To request or address issues:
- Explain your background and how you plan to resolve the issue.
- Provide an estimated timeframe for resolving the issue.
- For ODHacks, issue requests will only be considered through OnlyDust.
We prefer contributors with Cairo experience. If you're a beginner but eager to learn, you're still welcome! In either case:
- Clearly explain your proposed solution for any issue.
- Tasks will be assigned to those best suited to resolve them.
-
Fork the Repository Fork the repository to your GitHub account.
-
Clone Your Fork Clone the repository locally:
git clone https://github.com/your-username/CitizenOfArcanisBackend.git
cd CitizenOfArcanisBackend
Use our branch naming conventions:
Type | Naming Convention | Example |
---|---|---|
Bug fixes | bugfix-issue-name |
bugfix-login-error |
New features | feat-feature-name |
feat-new-marketplace |
Documentation | docs-update-description |
docs-readme-update |
Refactoring | refactor-description |
refactor-ui-cleanup |
Steps to create a branch:
- Use the appropriate naming convention.
- Example command:
git checkout -b feat-new-marketplace ```
- Modify the codebase as needed.
- Test your changes to ensure the game works as expected.
Stage and commit your changes with a descriptive message:
git add .
git commit -m "feat: added new cyberpunk map"
Push the branch to your fork:
git push origin branch-name
Once you're ready:
- Open a Pull Request (PR) to the main repository.
- Include:
- A descriptive title (match the issue name).
- A detailed explanation of your changes.
- References to related issues (if applicable).
Josué | Kevin |
In Citizen of Arcanis, the world isn’t just yours to explore—it’s yours to control!