Skip to content

Latest commit

 

History

History
38 lines (22 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

38 lines (22 loc) · 1.69 KB

Contributing to Our Project

Thank you for considering contributing to Arkyide Project! We welcome contributions of all kinds, and we're excited to see what you'll bring to the table. To get started, please follow the guidelines below.

Join Our Community

We invite you to join our Discord server to stay connected with the community, ask questions, and get support.

Invitation link: https://discord.gg/z56VYCq8

How to Contribute

Reporting Issues

If you find any bugs or have a feature request, please open an issue on GitHub. Make sure to provide detailed information to help us understand the problem or the feature you're requesting.

Pull Requests

  1. Fork the repository and create your branch from main.
  2. Make your changes and ensure your code passes all tests.
  3. Submit a pull request to the main branch.

Pull Request Guidelines

  • Ensure your code passes all tests before submitting a pull request.
  • Include clear descriptions and related issue numbers in your pull request.
  • Follow the coding style and conventions used in the project.

Handling CI Check Failures

If your pull request fails the CI checks, please follow these steps:

  1. Fix Code to Pass Tests: Review the CI logs, identify the issues, and make the necessary changes to pass all tests.
  2. Alert Someone to Analyze Tests: If you're unable to resolve the issues, alert someone from the team to analyze the test failures.
  3. Recreate Some Tests if Nothing Else Works: As a last resort, you may need to recreate some tests to ensure they accurately reflect the current state of the code.

We appreciate your effort in maintaining the quality of the codebase and thank you for your contributions!