Skip to content

Latest commit

 

History

History
67 lines (44 loc) · 4.38 KB

CONTRIBUTING.md

File metadata and controls

67 lines (44 loc) · 4.38 KB
Raw

Contributing to MapleStory: Design

Before anything, thank you for your willingness to contribute to our project and bettering the simulator for each and every mapler. 👍

The following is a set of guidelines for contributing to MapleStory: Design, which is provided by Crrio on GitHub. These are just guidelines, not rules. Use your best judgment, and remember any major changes may take additional approval by our team.

Table Of Contents

Getting Started

How Can I Contribute?

Getting Started

Our Purpose

This project's mission is to create an innovative all-in-one simulator for the MMORPG, MapleStory which is provided by NEXON. Any pull requests, issues, or otherwise requests that stray away from this purpose may be rejected.

Our Legal Commitment

As a company, Crrio is required to abide by NEXON's legal requirements and terms requiring that we state that all aspects of our service are the following:

  • Un-official, and not directly affiliated by Nexon America, or NEXON.
  • All assets, game data, and information regarding their game(s) are owned by them.
  • All media or otherwise user-created content made using this simulator must be accessible without any monitization.

How Can I Contribute?

Bug Reports

Bugs can happen, and they usually make for a bad experience for everyone. Whenever a bug report is created, we will usually quickly act upon it, research the causes, and apply a fix when possible. Bug Reports are tracked as GitHub issues.

Feature Requests

Every single individual sees the world in a different light, and we're appreciative of those that can imagine creative ways to better or improve MapleStory: Design. for everyone. Feature requests are tracked as GitHub issues.

Making A Feature Request

  • Use a clear and descriptive title for the issue to identify the request.
  • Provide a step-by-step description of the feature in as many details as possible.
  • Explain why this feature would be useful to most MapleStory players and generally benefits the service in some manner.

We believe in quality not quantity, so we prefer well thought-out features over creating many of them with limited functionality or usage.

Pull Requests

We're thankful to each and every individual who has dedicated their time towards bettering our services, however with this in mind we have some requirements for pull requests to ensure a safe experience for every player.

Making a Pull Request

  • 1. Fork the repo. To preserve quality commits and for safety, only Crrio team members may commit directly to our repository. To contribute an update or otherwise commit that resolves an Issue, you will need to first fork a copy to your own account. For more information about creating a fork, click here.
  • 2. Create a unique branch name. To prevent possible branch conflicts, we recommend using a unique name such as "fixes-item-bug" or your github username. For more information on creating a branch, click here.
  • 3. Push your commit. After you've created your branch, commit the changes you've made and make sure to sync it.
  • 4. Create a pull request. To properly submit your changes to this repository, you will need to create a pull request and then compare your branch to our dev branch. Any pull requests to master will be immediately rejected. For more information on creating pull requests from a remote branch, click here

Be sure to include as much information as possible in your pull request description, including any Issues you've resolved to make it easier for our team to test it. If we believe that it is a quality pull request or properly resolves an Issue, we will merge it to dev until we push everything to production (master).