Skip to content

Latest commit

 

History

History
107 lines (68 loc) · 4.98 KB

CONTRIBUTING.md

File metadata and controls

107 lines (68 loc) · 4.98 KB
Raw

Contributing to Trasy

Firstly, thank you for considering contributing to TrasyError! It's people like you that make the open-source community such a fantastic place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Code of Conduct

This project and everyone participating in it is governed by the Trasy Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [project-email@example.com].

How Can I Contribute?

Contributions to TrasyError can be made in a number of ways, not just by submitting code. Here are some ways you can help:

  • Reporting Bugs
  • Suggesting Enhancements
  • Writing Documentation
  • Submitting pull requests

Reporting Bugs

This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Before Submitting A Bug Report

  • Check the debugging guide for tips — you might be able to find the cause of the problem and fix it yourself.
  • Determine which repository the problem should be reported in.
  • Check if the issue has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.

How Do I Submit A Good Bug Report?

Bugs are tracked as GitHub issues. Create an issue and provide the following information by filling in the template.

Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Provide specific examples to demonstrate the steps.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for TrasyError, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.

Before Submitting An Enhancement Suggestion

  • Check if the enhancement has already been suggested. If it has, add a comment to the existing suggestion instead of opening a new one.

How Do I Submit A Good Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. Create an issue and provide the following information:

  • Use a clear and descriptive title for the issue.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Explain why this enhancement would be useful to most TrasyError users.

Pull Requests

The process described here has several goals:

  • Maintain TrasyError's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible TrasyError

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

How to Submit A Pull Request

  1. Fork the repository.
  2. Create a new branch for each feature or improvement.
  3. Send your pull request from your feature branch to the original master branch.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
  • Limit the first line to 72 characters or less.
  • Reference issues and pull requests liberally after the first line.

Rust Styleguide

Starting Points

Here are some ideas for how you can start contributing:

  • Review [BEGINNER] tagged issues: These are issues that would only require a few lines of code, and a test or two.
  • Help to fix bugs reported in issues.
  • Improve documentation.
  • Add more tests to existing functionality.

We hope this guide helps you get started as a contributor to TrasyError. If you have any questions or need help, please don't hesitate to ask.

Thank you for contributing!


### Notes:

- Be sure to create or adjust links like `CODE_OF_CONDUCT.md`, `ISSUE_TEMPLATE.md`, and `STYLE_GUIDE.md` according to your actual repository structure and available documents.
- If you do not yet have some of these documents or features like a style guide, you may want to create them or remove references to them from this guide.
- Personalize the contact email and GitHub repository URL with your actual project details.