CONTRIBUTING.md

Contributing to Gamium

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

Please report unacceptable behavior to contact us.

The following is a set of guidelines for contributing to Gamium. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

Issues

Issues are created here.

• How to Contribute in Issues
• Asking for General Help
• Submitting a Bug Report
• Triaging a Bug Report
• Resolving a Bug Report

Issue Closure

Bug reports will be closed if the issue has been inactive and the latest affected version no longer receives support.

If an issue has been closed and you still feel it's relevant, feel free to ping a maintainer or add a comment!

Languages

We accept issues in any language. When an issue is posted in a language besides English, it is acceptable and encouraged to post an English-translated copy as a reply. Anyone may post the translated reply. In most cases, a quick pass through translation software is sufficient. Having the original text as well as the translation can help mitigate translation errors.

Responses to posted issues may or may not be in the original language.

Pull Requests

Pull Requests are the way concrete changes are made to the code, documentation, dependencies, and tools contained in the gamium/gamium repository.

• Setting up your local environment
  • Step 1: Fork
  • Step 2: Build
  • Step 3: Branch
• Making Changes
  • Step 4: Code
  • Step 5: Commit
    • Commit message guidelines
  • Step 6: Rebase
  • Step 7: Test
  • Step 8: Push
  • Step 9: Opening the Pull Request
  • Step 10: Discuss and Update
    • Approval and Request Changes Workflow
  • Step 11: Landing
  • Continuous Integration Testing

Style Guides

See Coding Style for information about which standards Gamium adheres to in different parts of its codebase.

Further Reading

For more in-depth guides on developing Gamium, see the following:

• Source Code Organization