Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

60 lines (41 loc) · 2.03 KB

Contributing to GDG-Biet Projects

Thank you for your interest in contributing to GDG-Biet! Here’s how you can get started.

How to Contribute

  1. Fork the Repository:

    • Fork the repo to your own GitHub account.
  2. Clone the Forked Repository:

    • Use git clone to clone the repo to your local machine.
  3. Create a New Branch:

    • Make sure you create a new branch for your work:
      git checkout -b my-new-feature
  4. Commit Your Changes:

    • Once your changes are ready, make sure to commit them with a meaningful message:
      git commit -m "Add new feature"
  5. Push Your Changes:

    • Push the changes to your forked repo:
      git push origin my-new-feature
  6. Submit a Pull Request:

    • Submit a pull request to the main repo, and describe what you’ve done.

Style Guide

  • Follow consistent naming conventions.
  • Write clean, understandable code.
  • Provide tests if applicable.

Guidelines

  • Code Style: Please ensure your code follows the project’s coding style. Use consistent indentation and descriptive variable names.
  • Testing: If applicable, add tests to verify the functionality of your changes.
  • Commit Messages: Write clear, concise commit messages that explain what changes you've made.
  • Pull Requests: Make sure your pull request (PR) is well-documented. Link any relevant issues and describe what problem your change solves.

Reporting Issues

If you encounter any issues, please open an issue. Be sure to provide enough detail for us to reproduce the problem.

  • Bug Reports: Include details such as operating system, steps to reproduce, expected behavior, and any error messages.
  • Feature Requests: Provide a clear explanation of the feature, the use case, and any examples.

Code of Conduct

Please note that this project follows our Code of Conduct, and by participating, you agree to abide by it.


Thank you for contributing!