Skip to content

Latest commit

 

History

History
49 lines (25 loc) · 3.86 KB

contributing.md

File metadata and controls

49 lines (25 loc) · 3.86 KB
Raw

Contribution Guidelines

Thank you for considering contributing to the Club Directory project! We appreciate your interest and involvement in making this project a success. By contributing, you can help improve the directory and enhance the collaboration and connectivity among Hack Clubs worldwide. To ensure a smooth and effective contribution process, please follow these guidelines:

Finding an Issue

  1. Browse the Issue Tracker: Start by browsing the project's issue tracker on GitHub. Look for open issues labeled "help wanted" or "good first issue" that align with your skills or interests. These issues are often beginner-friendly and a great way to start contributing.

  2. Discuss Your Idea: If you have an idea for a contribution that is not yet listed as an issue, you can create a new issue to discuss it with the project maintainers. They can provide guidance on the feasibility and suitability of your idea.

Contributing Code

  1. Fork the Repository: Start by forking the Club Directory repository to your own GitHub account. This will create a copy of the repository under your account, allowing you to make changes without affecting the original project.

  2. Clone the Repository: Clone the forked repository to your local machine using your preferred Git client.

  3. Create a New Branch: Create a new branch for your contribution. Use a descriptive branch name that summarizes the purpose of your changes.

  4. Make Changes: Implement your changes or additions to the codebase. Follow the project's coding style and guidelines. Write clear, concise, and well-documented code.

  5. Test Your Changes: Test your changes thoroughly to ensure they work as expected and do not introduce any regressions. If applicable, include test cases to validate your changes.

  6. Commit and Push: Commit your changes with a clear and descriptive commit message. Push the changes to your forked repository.

  7. Open a Pull Request: Open a pull request on the main repository. Provide a detailed description of your changes, including the problem solved and the approach taken. Reference any related issues or discussions.

  8. Review and Iteration: The project maintainers will review your pull request and provide feedback. Be responsive to the feedback and make necessary changes or improvements if requested. This may involve multiple iterations of reviews and revisions.

  9. Merge and Close: Once your pull request has been approved, it will be merged into the main repository. Congratulations on your contribution!

Contributing Documentation

  1. Fork the Repository: Start by forking the Club Directory repository to your own GitHub account. This will create a copy of the repository under your account, allowing you to make changes without affecting the original project.

  2. Clone the Repository: Clone the forked repository to your local machine using your preferred Git client.

  3. Make Changes: Edit or create new documentation files to improve the project's documentation. This may include updating the README, adding inline code comments, or creating a new documentation section.

  4. Commit and Push: Commit your changes with a clear and descriptive commit message. Push the changes to your forked repository.

  5. Open a Pull Request: Open a pull request on the main repository. Provide a detailed description of your changes and the purpose of the documentation improvements.

  6. Review and Iteration: The project maintainers will review your pull request and provide feedback. Be responsive to the feedback and make necessary changes or improvements if requested. This may involve multiple iterations of reviews and revisions.

  7. Merge and Close: Once your pull request has been approved, it will be merged into the main repository. Congratulations on your contribution!

Code of Conduct

Please note that all contributions to the Club Directory project are subject to our Code of Conduct.