-
Notifications
You must be signed in to change notification settings - Fork 3
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
22 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,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! |