Skip to content

Latest commit

 

History

History
61 lines (42 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

61 lines (42 loc) · 2.6 KB
Raw

Updated CONTRIBUTING.md

# GlPortal Contribution Guide

We welcome contributions from developers, artists, composers, and writers! Whether you're looking to fix a bug, add a feature, or create new content, we encourage you to get involved.

## Getting Started

### Developer
1. **Set up your environment:**
   - Follow the [Compile Guide](https://github.com/GlPortal/glPortal/blob/master/COMPILE.md) to build the game.
   
2. **Choose a task:**
   - Check the [bug tracker](https://bugs.glportal.de/) for tasks you want to work on or add your own ideas.

3. **Make your changes:**
   - Create a new branch for your work and implement your changes.

4. **Submit a Pull Request:**
   - Once you're happy with your changes, send a pull request on GitHub for review.

### Artist
1. **Contact us:**
   - Say hello in [Gitter](https://gitter.im/GlPortal/glPortal?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) or [IRC](http://webchat.freenode.net/?channels=%23glportal&uio=d4).
   
2. **Collaborate:**
   - Discuss your ideas and find out how you can contribute to the visual aspects of GlPortal.

### Composers
1. **Check our music guidelines:**
   - Refer to the [music guidelines](https://github.com/GlPortal/specification/blob/master/music.md).

2. **Contribute your work:**
   - Optionally, add your note-sheets to our [repository](https://github.com/GlPortal/music).
   - Add your license and tracks to the [raw data repository](https://github.com/GlPortal/glportal_raw_data/tree/master/audio/music).

### Quality Control
1. **Review and Test:**
   - Test changes in the game and provide feedback.
   
2. **Implement or Suggest Changes:**
   - If you can fix it yourself, go ahead and make the changes.
   - If you're unsure, propose the change as a pull request for review.

### Writers
1. **Get started with GitHub:**
   - Create a GitHub account and learn the basics of [using GitHub in the browser](https://help.github.com/articles/github-flow-in-the-browser/).

2. **Contribute to Documentation:**
   - Help us improve documentation by editing files directly in the repository. For a detailed guide, check [editing files in other people's repositories](https://help.github.com/articles/editing-files-in-another-user-s-repository/).

## Submitting Your Contribution
- Create a new branch for your changes.
- Make your changes and commit them with a descriptive message.
- Push your branch to your forked repository.
- Open a pull request from your branch to the `main` branch of the GlPortal repository.

We look forward to your contributions and are here to help if you have any questions. Happy contributing!