Skip to content

Latest commit

 

History

History
86 lines (66 loc) · 3.72 KB

CONTRIBUTING.md

File metadata and controls

86 lines (66 loc) · 3.72 KB
Raw

Contributing Guidelines

Welcome to the Shonan Code Summit (ShoCode) repository! We're glad you're here and interested in contributing to our community-driven event. This document outlines some guidelines for contributing to the ShoCode repository, including how to submit code contributions, report bugs, suggest new features, and participate in discussions.

Code Contributions

We welcome code contributions that align with the goals and values of the ShoCode community. A code contribution can be a paper submission, updates to documentation, or code that supports the event. To submit a code contribution, please follow these steps:

  1. Fork the repository and create a new branch for your contribution.
  2. Make your changes and ensure that your code follows the project's coding conventions and style.
  3. Write tests for your changes and ensure that they pass.
  4. Submit a pull request to the main repository and provide a clear description of your changes.

Please ensure that your pull request adheres to the following guidelines:

  • Clearly state the purpose and scope of your contribution.
  • Explain any dependencies, testing strategies, or deployment considerations that may be relevant.
  • Include relevant documentation updates or examples.
  • Be willing to collaborate and address feedback or issues that may arise during the review process.

Bug Reports

If you encounter a bug or error in the ShoCode repository, please submit a detailed bug report that includes the following information:

  • A clear description of the problem, including any error messages or symptoms.
  • Steps to reproduce the problem.
  • Any relevant information about your environment, such as the operating system, browser, or device.
  • Any relevant logs, screenshots, or other supporting evidence.

Please submit your bug report as a new issue in the repository and tag it with the "bug" label.

Feature Requests

We welcome feature requests that align with the goals and values of the ShoCode community. A feature request can be anything from how we manage the event to enhancements to the ShoCode repository. To submit a feature request, please follow these steps:

  1. Check if the feature request already exists by searching the existing issues.
  2. If the feature request does not exist, create a new issue that clearly states the purpose and scope of the feature.
  3. Provide any relevant documentation, user stories, or mockups that may help to illustrate the feature.
  4. Be willing to collaborate and address feedback or issues that may arise during the review process.

Please submit your feature request as a new issue in the repository and tag it with the "enhancement" label.

Discussions

The ShoCode repository also serves as a forum for community-driven discussions related to the event, technology, and related topics. To participate in a discussion, please follow these guidelines:

  1. Be respectful and courteous to other participants, regardless of their backgrounds or viewpoints.
  2. Stay on-topic and avoid straying into unrelated or contentious topics.
  3. Listen actively and empathetically to others, and avoid interrupting or talking over others.
  4. Be open to feedback and new ideas, and avoid making assumptions or generalizations about individuals or groups.

Please use the issues or pull requests in the repository to initiate a discussion.

Conclusion

Thank you for your interest in contributing to the Shonan Code Summit (ShoCode) repository. We value your contributions and are committed to maintaining a safe, inclusive, and respectful community for all participants. Please review and adhere to these guidelines as you contribute to the repository. If you have any questions or concerns, please reach out to the event organizers or moderators.