Skip to content

Latest commit

 

History

History
40 lines (30 loc) · 2.46 KB

ContributorGuidelines.md

File metadata and controls

40 lines (30 loc) · 2.46 KB
Raw

Smart Agent Project: Contributor Guidelines

Welcome! Glad you are interested in contributing to the Smart Agent open source project. Here is a short set of guidelines for contributors to follow.

Table of Contents

  • Communication Channels
  • Getting Started
  • Reporting Issues
  • Submitting Changes
  • Code Standards
  • Testing
  • Documentation

1. Communication Channels

We utilize Discord for project-related developer communication. If you have questions about the project or need help getting started, don't hesitate to reach out. Please respect everyone's time and ensure your questions are clear, concise, and relevant to the project. https://discord.gg/fZ8zvFSRSb

2. Getting Started

Before getting started, please ensure you have the most recent version of the project. Fork the repository and clone it to your local machine to get started. If you're new to contributing, look for issues tagged as 'good first issue'.

3. Reporting Issues

If you find a bug or have a suggestion for an enhancement, first check the issue tracker to see if it has already been reported. If not, feel free to open a new issue. Please include a clear description of the issue and steps to reproduce it if it's a bug.

4. Submitting Changes

Branching: Create a new branch for each issue you're working on. Try to name your branches in a way that reflects the issue you're addressing. Commits: Make sure your commit messages are clear and descriptive. This will help reviewers understand your thinking process and make the review process smoother. Pull Requests: Once your changes are ready, submit a pull request (PR). Include a detailed description explaining your changes and the issue they're addressing. Code Review: Your PR will then go through a code review. Respond to any comments or requests for changes in a timely manner.

5. Code Standards

Follow the coding standards established in the project. This includes things like naming conventions, comment style, and indentation. If you're unsure about anything, check the documentation.

6. Testing

Make sure to test your changes before submitting them. If the project includes automated tests, make sure they all pass after your changes. If your changes require, add new test cases.

7. Documentation

When adding or modifying code, also update relevant documentation. This includes code comments, READMEs, and any external documentation. If you're adding a new feature, provide clear, concise documentation explaining how to use it.

Happy coding!