ACE3/.github/CONTRIBUTING.md

Reporting an issue

Before reporting

If you have found an issue with ACE3 please make sure that ACE3 really is the cause of the problem. To do this try to reproduce the issue with using only @CBA_A3 and @ace on a newly created mission.

Indicate if the issue appears on stable or development version. In case it is the development version, please also include the commit SHA-1 hash.

Please note:

• It's not a valid to simply remove @ace from the mod list to confirm that ACE3 is the culprit.
• If the error happens when using a third-party mod contact the author of the appropriate mod and report the issue there.

Reporting the issue

Head over to the ACE3 GitHub issue tracker and press the New issue button in the top right corner. Add a descriptive title and complete the issue template.

A video of the issue might be helpful in resolving it faster.

Feature Requests

Background

ACE2, AGM and CSE had a lot of features implemented or planned. All of them are or have been evaluated for inclusion in ACE3 itself, and we'd like to port the majority of them eventually. However, due to time constraints, we have managed to finish only a fraction of the job so far.

Please refrain from making requests for any planned or existing features from either ACE2, AGM or CSE. Most of them are already being or have been considered for porting or a rewrite.

Requesting a feature

In order to avoid duplicates and keep the issue tracker organized, we have created a common issue for ACE3 Feature requests. Any and all relevant requests should be submitted there, where they will also get discussed and evaluated. Before adding a new one, make sure to check the previous entries from the thread and do a quick search for similar suggestions; please don't reiterate requests for features that had already been accepted for inclusion, or those which were disregarded earlier.

Following their approval, feature requests may be moved by moderators to a separate issue for further discussion.

Contributing to the project

We welcome anyone to contribute to this repository. Issues that we are actively seeking help with, are marked as help wanted. Feel free to pick up any of those issues.

Pull Request process

When contributing to this repository, please first discuss the change you wish to make via issue or Discord with the ACE3 project maintainers before making a change. This may not be necessary if you are contributing for something which has an existing issue in our repository already.

1. Please make a pull request (PR) as early as possible. This lets use help you in the proces of developing it. When opening a work in progress pull request, mark your PR with a WIP: prefix.
2. Describe what this pull request will do and how it solves this in the description of your PR. A clear intent and description of the way the issue is resolved will help us to review the PR more efficiently.
3. Please follow our Development Guidelines.

Notes

Please note that all contributors to this project are volunteers and do this in their own time. This means that issues and/or PRs may be open for a long time before being picked up and reviewed. We try to keep this time as short as possible, but some times things may fall short. If you feel that an issue or PR has not received attention, please comment asking for a review using the mention @acemod/maintainers.

Assistance with contributing

If you require assistance with contributing, check out the #dev channel on our Discord. Additional documentation can be found on our Development wiki.