Skip to content

Latest commit

 

History

History
66 lines (50 loc) · 3.7 KB

contributing.md

File metadata and controls

66 lines (50 loc) · 3.7 KB

code of conduct

This section will be updated with a link to the Code of Conduct file once it is available.

reporting bugs

To report a bug, please follow these steps:

  1. Search Existing Issues: Before creating a new bug report, please check the existing issues to see if the problem has already been reported.

  2. Create a New Issue: If no existing issue matches, open a new issue and use the provided bug report template. Include as much detail as possible, such as steps to reproduce the bug, expected behavior, and screenshots if applicable.

suggesting new features

To suggest a new feature:

  1. Search Existing Issues: Look through the existing issues to see if the feature has already been suggested.
  2. Create a New Feature Request: If the feature has not been suggested yet, open a new issue and use the feature request template. Describe the feature, its purpose, and any other relevant details.

suggesting enhancements

To suggest enhancements to existing features:

  1. Search Existing Issues: Check if someone has already proposed the enhancement.
  2. Create a New Enhancement Request: If the enhancement has not been suggested, create a new issue using the enhancement request template. Clearly explain the enhancement and how it will improve the project.

style guide

Placeholder

how to contribute

  1. Fork the (https://github.com/swarmauri/swarmauri-sdk) repository to your own GitHub account.

  2. Star the repository.

  3. Watch the repository to stay updated with changes.

  4. Clone your fork to your local machine using the command: git clone https://github.com/your-username/swarmauri-sdk.git

  5. Commit Changes to Your Fork: git checkout [your-working-branch]

  6. Make your changes, commit them with descriptive messages, and push to your fork: git add . git commit -m "Add a meaningful commit message" git push origin feature/your-feature-name

  7. Every new feature or component must have an associated test file created first.

Each test must cover the following aspects:

  1. Type of Component: Verify that the component is of the expected type.
  2. Resource: Test the component's resource handling (e.g., input/output validation, dependencies).
  3. Serialization: Ensure proper serialization and deserialization of data.
  4. Access Method: Check how the component is accessed or invoked within the system.
  5. Functionality: Confirm that the component functions as intended and meets all defined requirements.

Once your changes are ready, create a pull request from your branch to the main repository's main branch.

Provide a detailed description of your changes, reference any related issues, and request reviews.

development setup

  1. Workflow logs are available in GitHub Actions feature to help you verify if your changes are working as intended. Check the logs to confirm whether tests for the changes you made passed or failed.

  2. How to enable GitHub Actions for Your Fork

    • Check for the Workflow File in Your Fork
      • GitHub Actions workflows are defined in .yml files under the .github/workflows directory in the repository.
      • Navigate to the .github/workflows directory in your forked repository on GitHub.
      • Ensure that the workflow file (e.g., staging.yml etc.) from the original repository is present in your fork.
    • Enable GitHub Actions for Your Fork
      • Go to your forked repository on GitHub.
      • Click on the "Settings" tab.
      • Under "Actions" in the left sidebar, ensure that Actions are enabled. If they're disabled, enable them.

licensing

This project is licensed under the Project License(https://github.com/swarmauri/swarmauri-sdk/blob/master/LICENSE). Please make sure that any contributions adhere to the terms of the license.