Skip to content

Latest commit

 

History

History
93 lines (70 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

93 lines (70 loc) · 2.76 KB

Contributing to arc

Thank you for considering contributing to arc! Your contributions help make this project better and more useful for everyone. Below you'll find guidelines for contributing to the project, including coding standards, submitting issues, and creating pull requests.

How Can You Contribute?

  1. Report Bugs: Found a bug? Let us know by opening an issue.
  2. Suggest Features: Have an idea for a new feature? We’d love to hear it! Create a feature request as a new issue.
  3. Write Code: Submit a pull request to add a feature, fix a bug, or improve documentation.
  4. Improve Documentation: Help us make our documentation clearer and more comprehensive.

Guidelines for Contributions

Reporting Issues

When opening an issue:

  • Search Existing Issues: Before creating a new issue, check if it has already been reported.
  • Be Clear: Provide as much detail as possible:
    • Steps to reproduce the problem
    • Expected behavior
    • Actual behavior
    • Environment details (OS, .NET version, etc.)

Submitting Pull Requests

  1. Fork the Repository:
    • Click the "Fork" button in the top-right corner of the repository page.
  2. Clone Your Fork: 
    git clone https://github.com/your-username/arc.git
cd arc
  3. Create a Branch:
    • Use a descriptive branch name: 
      git checkout -b feature/your-feature-name
  4. Write Code:
    • Follow the coding standards (see below).
    • Write unit tests for your changes where applicable.
  5. Run Tests:
    • Make sure all existing and new tests pass: 
      dotnet test
  6. Commit Changes:
    • Use clear, concise commit messages: 
      git commit -m "Add feature X"
  7. Push Your Branch: 
    git push origin feature/your-feature-name
  8. Create a Pull Request:
    • Go to your fork on GitHub and click the "Compare & pull request" button.
    • Provide a clear description of your changes and link any related issues.

Coding Standards

  • Code Style:
    • Use consistent indentation and formatting (recommended: Visual Studio or VS Code formatting tools).
    • Write clear, readable, and maintainable code.
  • Comments:
    • Add comments for complex logic or areas that may need clarification.
  • Tests:
    • Write unit tests for any new features or bug fixes.

Code of Conduct

Please note that we follow the Contributor Covenant Code of Conduct. By participating in this project, you agree to abide by its terms.

Need Help?

If you have any questions or need further assistance, feel free to:

  • Open a new issue.
  • Reach out to the maintainers.

Thank you for contributing to arc! 🎉