Skip to content

Latest commit

 

History

History
55 lines (35 loc) · 2.5 KB

contributing.md

File metadata and controls

55 lines (35 loc) · 2.5 KB

Contributing Guidelines

Thank you for considering contributing! We appreciate your efforts to make this workshop better. To ensure a smooth collaboration, please follow these guidelines when contributing.

Ways to Contribute

1. Questions

If you have questions related to the workshop, code, or any other aspect, you can check the Discussions:

  1. Check existing issues and discussions to see if your question has been addressed.
  2. If not, open a new discussion.
  3. Clearly state your question, providing as much detail as possible.
  4. Be patient and respectful while waiting for a response from the community or our team.

2. Suggesting Corrections or Improvements to the Code

If you find bugs or have suggestions for improving the code, please follow these steps:

  1. Create a new issue in the repository.
  2. Use the "Bug Report" template if reporting a bug, or the "Feature Request" template for suggesting improvements.
  3. Provide a clear and concise description of the issue or suggestion.
  4. You can include relevant details, such as the environment, steps to reproduce the issue, and expected behavior.

3. Suggesting Changes to the Content

If you have ideas for modifying or enhancing the workshop content, follow these steps:

  1. Open a new issue using the "Content Change" template.
  2. Clearly state the proposed changes or additions.
  3. Provide context on why you think the changes are necessary or beneficial.
  4. You can include any relevant links or references to support your suggestions.

4. Reporting Errors

To report any errors in the documentation, instructions, or any other aspect of the project, use the following steps:

  1. Create a new issue with the "Documentation Issue" template.
  2. Clearly describe the error and its location.
  3. If possible, suggest corrections or improvements.
  4. Include any relevant screenshots or examples.

5. Any Other Contributions

If you have other ideas, features, or contributions in mind that are not covered above, follow these general steps:

  1. Open a new issue with an appropriate template or a custom description.
  2. Clearly explain your proposed contribution and its purpose.
  3. Provide any necessary details to help understand and implement your contribution.

Code of Conduct

Please note that all contributions should adhere to our Code of Conduct. Ensure respectful and inclusive communication throughout the contribution process.

Thank you for helping make this workshop better!