CONTRIBUTING.md

Participiant: How to Contribute

Prerequisites :

• Must have a UNIX environment (any linux distro/wsl/macos).
• Have valgrind installed.

Steps to Contirubute :

1. Visit the HackNight 6.0 Leaderboard: Browse the leaderboard and choose a repository you'd like to contribute to!

2. Check for Open Issues: Look for any open issues in the repository. If you find one that interests you, ask to be assigned to it by commenting on the issue.

3. Setup Your Codebase:

   • Fork the repository to your GitHub account and copy it's clone URL
   • Clone your forked repository to your local machine using Git (make sure it's installed)

   git clone [email protected]:your-username/repo-name.git

4. Make Your Changes After cloning and setting up your branch, make the necessary changes to the code in your IDE.

5. Run Make valgrind

   make valgrind

   Ensure that there aren't memory leaks.

6. Commit and Push: Commit your changes and push them to your fork:

   git commit -m "Describe the changes you made"
   git push

   Alternatively, use VSCode's inbuilt Git source control pane Ctrl+Shift+G if you're unconfortable with a CLI

7. Submit a Pull Request: After pushing your changes, open a pull request to pull changes from your fork to the original repository.

8. Get Feedback Wait for a maintainer to review your pull request (PR) and provide feedback.

9. Gain Bounty Points If everything is approved, your issue will be closed, and you'll gain bounty points on the leaderboard!