Skip to content

Latest commit

 

History

History
65 lines (47 loc) · 3.1 KB

CONTRIBUTORS.md

File metadata and controls

65 lines (47 loc) · 3.1 KB
Raw

Contributing to Rift

Love Rift and want to get involved? You're in the right place! We appreciate your interest in contributing. Even if you aren't writing code, there are many ways to help contribute. This guide will help you understand how you can contribute to the project effectively.

Table of Contents

How to Contribute

Report Bugs

If you encounter any bugs or issues while using the Rift, please help us improve by reporting them. To report a bug, follow these steps:

  1. Go to the Issues section of the project on GitHub.
  2. Click on the "New Issue" button.
  3. Provide a clear and detailed description of the bug you encountered, along with steps to reproduce it if possible.

Suggest Features

Have a great idea for a new feature? We'd love to hear it! To suggest a new feature for Rift, follow these steps:

  1. Go to the Issues section of the project on GitHub.
  2. Click on the "New Issue" button.
  3. Describe the feature you'd like to see implemented, providing as much context and use cases as possible.

Update Docs

Documentation is vital for a successful open-source project. If you find any areas in the documentation that need improvement or want to add missing information, we appreciate your efforts. To contribute to the documentation

Write Code

We welcome contributions to the Rift codebase. If you want to contribute code, please follow these steps:

  1. Browse through the Issues section to find an existing issue you'd like to work on or identify a new improvement to make.
  2. Comment on the issue to express your interest in working on it and wait for approval from project maintainers.
  3. Fork the repository to your GitHub account.
  4. Create a new branch for your contribution, with a descriptive name related to the issue or task you're addressing.
  5. Make the necessary code changes and improvements.
  6. Write tests if applicable to ensure the code behaves as expected.
  7. Submit a Pull Request (PR) to the main repository, clearly explaining the changes you made and referencing the related issue.
  8. We'll review your PR as soon as possible and provide feedback or merge it into the project.

Editors

VSCode Extension

See rift-vscode

Vim

See rift-vim

Emacs

See rift-vim

Rift Engine

See rift-engine

We value every contribution, no matter the level of expertise, and appreciate the effort you put into making Rift better. Join our community of developers and help shape the future of software.

Feel free to explore our repositories, find issues to work on, and start contributing to Rift today. Thank you for being a part of our journey!