Skip to content

Latest commit

 

History

History
78 lines (50 loc) · 3.8 KB

COLLABORATION.md

File metadata and controls

78 lines (50 loc) · 3.8 KB

Collaboration Guidelines for Dashboard CTF Cyber Security 🚀

We are excited to have you as part of our core team! Contributing to this project means being part of a collaborative journey to create an impactful tool for the GDG on Campus UIN Jakarta community. This guide provides a detailed roadmap on how to contribute effectively while adhering to industry best practices. For further insights, please refer to How to Contribute.

🛠️ Contribution Workflow

To maintain a structured and efficient workflow, follow these steps when contributing:

1. Fork the Repository

Start by forking the main repository to your GitHub account. This creates a personal copy where you can make changes without affecting the original project.

2. Clone the Repository

Use the following command to clone your forked repository to your local machine:

git clone https://github.com/your-username/dashboard-ctf-cyber-security.git

3. Create a Feature Branch

Always create a new branch for the task or feature you are working on. Use meaningful branch names to keep things organized. For example:

git checkout -b feature/user-authentication

or

git checkout -b feature/user-authentication

4. Make Your Changes

Focus on one task per branch to keep changes isolated. Adhere to the project’s coding standards and include relevant comments to explain your work. This ensures that your code is easy to review and maintain.

5. Test Your Changes

Before committing, thoroughly test your changes to ensure they work as intended and do not break existing functionality. Testing is crucial for maintaining the integrity of the project.

6. Commit Your Changes

Write clear and descriptive commit messages to explain the changes you’ve made. For example:

git commit -m "Fix: Resolved login issue for admin dashboard"

7. Push Your Changes

Push your feature branch to your forked repository:

git push origin feature/add-user-authentication

8. Create a Pull Request (PR)

Go to the original repository and create a pull request from your branch. Provide a detailed description of the changes, including the problem solved and any dependencies introduced. Tag relevant team members for review.

✨ Best Practices for Collaboration

  • Follow the Code of Conduct: Respect and inclusivity are essential. Familiarize yourself with our Code of Conduct.
  • Small, Incremental Changes: Avoid large, sweeping changes. Break your work into manageable chunks to simplify reviews and reduce the risk of introducing bugs.
  • Stay Updated: Regularly sync your fork with the main repository to avoid merge conflicts. Use: 
    git fetch upstream
git merge upstream/main
  • Communicate: Use GitHub issues and pull requests to discuss your ideas and progress. Transparency ensures alignment with project goals.

🔄 Collaboration Etiquette

  • Ask for Feedback. Don’t hesitate to request feedback early in your work to ensure you’re on the right track.
  • Review PRs Respectfully. When reviewing others' pull requests, provide constructive and actionable feedback. Acknowledge good work and offer suggestions where necessary.
  • Be Open to Feedback. Accept suggestions gracefully and be willing to iterate on your work based on team input.

🌟 Recognizing Contributions

We value and appreciate every contribution, no matter the size. Your efforts directly impact the success of this project, and we’re committed to creating a supportive and rewarding experience for all contributors.

Let’s build something incredible together! If you have any questions or ideas, don’t hesitate to reach out via GitHub issues or our community channels. Happy coding! 💪