-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
61 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| # Contributing to roguelike_project | ||
|
|
||
| Welcome to roguelike_project We're thrilled that you're interested in contributing. Before you get started, please take a moment to review this guide, which outlines the contribution process and provides some helpful tips. | ||
|
|
||
| ## Table of Contents | ||
| - [Getting Started](#getting-started) | ||
| - [How Can I Contribute?](#how-can-i-contribute) | ||
| - [Code of Conduct](#code-of-conduct) | ||
| - [Issues](#issues) | ||
| - [Pull Requests](#pull-requests) | ||
| - [Style Guidelines](#style-guidelines) | ||
| - [License](#license) | ||
|
|
||
| ## Getting Started | ||
|
|
||
| - Make sure you have [Rust](https://www.rust-lang.org/) installed on your system. | ||
| - Fork this repository and clone it to your local machine. | ||
| - Create a new branch for your contribution: `git checkout -b feature/your-feature` or `bugfix/your-bugfix`. | ||
| - Follow the installation and setup instructions in the project's README if applicable. | ||
|
|
||
| ## How Can I Contribute? | ||
|
|
||
| There are several ways you can contribute to this project: | ||
|
|
||
| - Reporting Bugs: If you encounter a bug, please [open an issue](#issues) and provide detailed information about it. | ||
| - Enhancements: You can propose enhancements or new features by [opening an issue](#issues) and describing your idea. | ||
| - Code Contributions: If you'd like to contribute code, please follow the [pull request guidelines](#pull-requests) below. | ||
| - Documentation: Help improve the project's documentation by fixing typos or adding missing information. | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| Please review and adhere to our [Code of Conduct](CODE_OF_CONDUCT.md) to ensure a welcoming and inclusive community. | ||
|
|
||
| ## Issues | ||
|
|
||
| Issues are a great way to contribute to the project. If you encounter a bug, have a feature request, or want to discuss something related to the project, follow these steps: | ||
|
|
||
| 1. [Search for existing issues](../../issues) to see if your topic has been discussed before. | ||
| 2. If not, [open a new issue](../../issues/new). | ||
| 3. Fill in the issue template with relevant information, including steps to reproduce for bugs. | ||
|
|
||
| ## Pull Requests | ||
|
|
||
| If you'd like to contribute code, please follow these guidelines: | ||
|
|
||
| 1. Fork the repository and create a branch for your work. | ||
| 2. Make your changes, ensuring that they adhere to the [style guidelines](#style-guidelines). | ||
| 3. Write clear and concise commit messages. | ||
| 4. Test your changes thoroughly to ensure they don't introduce new issues. | ||
| 5. [Open a pull request](../../pulls) against the `main` branch. | ||
| 6. Provide a detailed description of your changes in the pull request template. | ||
|
|
||
| ## Style Guidelines | ||
|
|
||
| Please follow the coding style and conventions used in this project. If you're unsure, refer to the existing codebase for guidance. | ||
|
|
||
| ## License | ||
|
|
||
| By contributing to this project, you agree that your contributions will be licensed under the project's [LICENSE](LICENSE.md). | ||
|
|
||
| Thank you for considering contributing to roguelike_project! Your help is greatly appreciated. |