Skip to content

Latest commit

 

History

History
75 lines (47 loc) · 2.77 KB

CONTRIBUTING.md

File metadata and controls

75 lines (47 loc) · 2.77 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to sectool! Your contributions are essential to making this project better. Please take a moment to review the following guidelines to ensure a smooth collaboration process.

Code of Conduct

This project follows an inclusive and respectful Code of Conduct. All contributors are expected to adhere to its guidelines when participating in this project.

Getting Started

  1. Fork the repository by clicking the "Fork" button at the top right of the repository page. This will create a copy of the repository in your GitHub account.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/a13labs/sectool.git

  3. Create a new branch for your work:

    git checkout -b feature/my-new-feature

  4. Make your changes, add new features, fix bugs, or improve documentation.

  5. Commit your changes with meaningful commit messages:

    git commit -m "Add new feature: ..."

  6. Push your changes to your forked repository:

    git push origin feature/my-new-feature

  7. Open a pull request (PR) against the main branch of the original repository. Provide a clear title and description for your PR, detailing the changes you've made.

Coding Standards

  • Follow the official Go Style Guide when writing Go code.
  • Keep your code well-formatted by using tools like gofmt.
  • Write clear and concise comments and documentation.
  • Use descriptive variable and function names.

Testing

  • Write tests for new features and changes you introduce.
  • Ensure that existing tests continue to pass after your changes.

Commit Guidelines

  • Use semantic commit messages for your commits.
  • Separate subject from body with a blank line in the commit message.
  • Limit the subject line to 50 characters and use present tense (e.g., "Add feature" instead of "Added feature").
  • Use the body to explain the what and why of your changes, providing context where necessary.

Pull Requests

  • Keep pull requests focused on a single feature or change.
  • Provide a clear and descriptive title for your pull request.
  • Include information about the changes you've made in the pull request description.
  • Reference related issues or pull requests if applicable.

Feedback and Discussions

If you have questions, need clarification, or want to discuss new ideas, feel free to open an issue or start a discussion.

Licensing

By contributing to this project, you agree that your contributions will be licensed under the project's MIT License.

Thank you for your contributions! Your efforts are greatly appreciated.