Skip to content

Latest commit

 

History

History
122 lines (78 loc) · 5.63 KB

CONTRIBUTING.md

File metadata and controls

122 lines (78 loc) · 5.63 KB

GDSC IIIT Kalyani Hacktoberfest Website Contribution Guidelines

Thank you for considering contributing to the GDSC IIIT Kalyani's Hacktoberfest website! We welcome contributions from everyone. By participating in this project, you agree to abide by the following guidelines to ensure a productive and collaborative environment.

Table of Contents

Getting Started

Before contributing, please make sure you have:

  1. Forked the repository to your own GitHub account.
  2. Cloned the forked repository to your local machine.
  3. Installed any necessary dependencies.

How to Contribute

Reporting Bugs

If you find any bugs or issues on the website, please follow these steps:

  1. Check the existing issues to see if the bug has already been reported.
  2. If not, open a new issue and provide detailed information about the bug, including steps to reproduce it and any error messages you encounter.

Suggesting Enhancements

We welcome suggestions for improvements or new features. To suggest an enhancement:

  1. Check the existing issues to see if your idea has already been suggested.
  2. If not, open a new issue and describe your proposed enhancement in detail, including why it would be valuable.

Working on Issues

If you find an open issue that you'd like to work on, please:

  1. Comment on the issue to express your interest and let others know you're working on it.
  2. Fork the repository if you haven't already.
  3. Create a new branch for your work (git checkout -b feature/your-feature-name).
  4. Implement the changes or fixes.
  5. Ensure that your code adheres to the coding guidelines (see Coding Guidelines).
  6. Create a pull request (PR) when you're ready for review.

Creating Pull Requests

When creating a pull request, please:

  1. Give it a clear and descriptive title.
  2. Provide a summary of the changes and explain why they are necessary.
  3. Reference any related issues by including the issue number in the PR description.
  4. Be responsive to feedback and make necessary changes if requested.
  5. Ensure that all tests pass and the code is well-documented.
  6. Follow the Commit Message Guidelines.

Coding Guidelines

To maintain consistency and readability in the codebase, please adhere to the following guidelines:

  1. Use clear and descriptive variable and function names.
  2. Follow the indentation and formatting conventions used in the existing code.
  3. Write comments to explain complex logic or non-obvious parts of the code.
  4. Keep the code DRY (Don't Repeat Yourself).

Commit Message Guidelines

  1. Write a clear commit message which will be a breif about the changes

Code of Conduct

Introduction

Our community is dedicated to providing a harassment-free experience for everyone, regardless of age, gender, gender identity and expression, sexual orientation, disability, physical appearance, body size, race, ethnicity, national origin, religion, or technology choices. We do not tolerate harassment of community members in any form.

This code of conduct applies to all community spaces, both online and offline, including our website, forums, social media, meetups, and events. Anyone who violates this code of conduct may be sanctioned or expelled from these spaces at the discretion of the community organizers.

Expected Behavior

  • Be respectful and considerate of others.
  • Be welcoming and inclusive.
  • Be mindful of your words and actions and their impact on others.
  • Encourage and support each other.
  • Use welcoming and inclusive language.

Unacceptable Behavior

Harassment and unacceptable behavior include, but are not limited to:

  • Offensive comments related to gender, gender identity and expression, sexual orientation, disability, physical appearance, body size, race, ethnicity, national origin, religion, or technology choices.
  • Unwanted advances or attention.
  • Encouraging self-harm or harm to others.
  • Threats or incitement of violence towards any individual or group.
  • Deliberate intimidation.
  • Inappropriate photography or recording.
  • Sustained disruption of events, forums, or meetings.
  • Other conduct that is offensive, disrespectful, or creates an unsafe environment.

Consequences of Unacceptable Behavior

Unacceptable behavior from any community member will not be tolerated. Anyone asked to stop unacceptable behavior is expected to comply immediately. If a community member engages in unacceptable behavior, the community organizers may take any action they deem appropriate, up to and including a temporary ban or permanent expulsion from the community without warning.

Reporting Guidelines

If you are subject to or witness unacceptable behavior, or have any other concerns, please notify a community organizer as soon as possible. You can contact us through our offical Discord or contact the maintainers. All reports will be kept confidential.

Credits

This Code of Conduct is based on the original Hacktoberfest Code of Conduct, which is open source and released under the Creative Commons Attribution-ShareAlike license.

GDSC IIIT Kalyani Hacktoberfest Code of Conduct