Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Arya-f4 authored Sep 27, 2024
1 parent 1a21523 commit 7e976b6
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Contributing to Arya-f4/Worldshellfinder
We appreciate your interest in contributing to the Arya-f4/Worldshellfinder! This document provides some basic guidelines for contributors.

## Getting Started
Always base your work from the dev branch, which is the development branch with the latest code.
Before creating a Pull Request (PR), make sure there is a corresponding issue for your contribution. If there isn't one already, please create one.
Include the problem description in the issue.
## Pull Requests
When creating a PR, please follow these guidelines:

Link your PR to the corresponding issue.
Provide context in the PR description to help reviewers understand the changes. The more information you provide, the faster the review process will be.
Include an example of running the tool with the changed code, if applicable. Provide 'before' and 'after' examples if possible.
Include steps for functional testing or replication.
If you're adding a new feature, make sure to include unit tests.
## Code Style
Please adhere to the existing coding style for consistency.

## Questions
If you have any questions or need further guidance, please feel free to ask in the issue or PR, or reach out to the maintainers.

Thank you for your contribution!

0 comments on commit 7e976b6

Please sign in to comment.