Documentation

Welcome to the seu.github.io project! This project is built by the S3DI team, and we are excited to have you contribute. To ensure smooth collaboration and maintain the quality of the project, please review the following contribution guidelines before making your contributions.

If you don’t understand the github open source project contribution process at all, it is strongly recommended to read: first contributions

Table of Contents

  1. How to Contribute
  2. Code of Conduct
  3. Issues
  4. Submitting a Pull Request
  5. Commit Message Guidelines
  6. Testing
  7. License

How to Contribute

The S3DI team is proud to collaborate on this project, and we welcome contributions from developers and researchers who are passionate about our work! There are several ways you can contribute:

  • Bug Reports: If you encounter a bug or issue, please report it by opening a new issue.
  • Feature Requests: Suggest new features or improvements to the project by opening an issue.
  • Code Contributions: You can submit pull requests to add features, fix bugs, or improve the project.

Before you start, check the open issues to see if there are any tasks or bugs that need attention.

Code of Conduct

We are committed to maintaining a welcoming and inclusive environment for all contributors. By participating in the seu.github.io project, you agree to follow our Code of Conduct.

Issues

If you find a bug or want to propose a new feature, please create an issue with the following information:

  • A clear and descriptive title.
  • Steps to reproduce the issue, if relevant.
  • Relevant logs, error messages, or screenshots.
  • For feature requests, include a description of how it would improve the project.

Submitting a Pull Request

To submit a pull request to the seu.github.io project, please follow these steps:

  1. Fork the repository: If you do not have direct write access, fork the project to your own GitHub account.

  2. Clone the repository:

    git clone https://github.com/your-username/project-name.git

  3. Create a new branch

    for your feature or fix:

    git checkout -b feature/your-feature-name

  4. Make your changes. Follow the coding standards and best practices outlined in the project.

  5. Commit your changes with a clear and detailed commit message.

  6. Push your changes

    to your forked repository:

    git push origin feature/your-feature-name

  7. Open a pull request to the main branch of the S3DI repository.

Once your pull request is submitted, the S3DI team will review it, provide feedback, and merge it if everything is in order.

Commit Message Guidelines

Please use the following guidelines for your commit messages:

  • Use imperative mood: Example: “Fix issue with data synchronization” (not “Fixed issue”).
  • Limit the subject line to 50 characters.
  • Capitalize the subject line.
  • Separate the subject and body with a blank line.
  • Wrap the body at 72 characters.

Example commit message:

Add user authentication feature

This feature allows users to securely log in using their credentials.

Testing

Before submitting a pull request, ensure that your changes are properly tested. If you’ve added or modified functionality, write tests to verify your changes. If the project uses a specific testing framework, such as pytest or JUnit, please run the tests before pushing your changes.

License

By contributing to the seu.github.io, you agree that your contributions will be licensed under the same license as the project. See the LICENSE file for more details.