Skip to content

Contributing.md

Latest commit

 

History

History
94 lines (64 loc) · 2.95 KB

Contributing.md

File metadata and controls

94 lines (64 loc) · 2.95 KB

Contributing to acm-fun 📝

We have one motto in life. Have fun xoxo. Because you only live once.

Getting Started 🚀

Before you embark on your journey as a contributor, let's ensure you have everything set up and ready to roll.

Types of Contributions ⚛

You can contribute to acm-fun in the following ways:

  • Issues: Check the Issues menu for pending issues raised earlier.
  • Feature/UI: Submit bug fixes, implement new features, or improve existing functionality & UI.
  • Bug Reports: Report bugs by creating detailed issue reports with clear steps to reproduce.

Requirements 👨‍💻

To contribute to acm-fun, you will need the following:

  • Github Account
  • Git
  • Node
  • NPM

Once everything is setup, you are good to go with following steps:

1. Create an Issue 📜

  • Head over to the Main Repo Issues and create a new issue.
  • Once the issue is assigned to you, you may proceed further.

For hacktoberfest participants, make sure you add hacktoberfest label to your issue, to get your issue/PR get counted for the same.

2. Fork and Clone 🍴

  • First, fork the repository to your GitHub account. This will create your personal copy.
  • Now, clone your forked repository to your local machine.
    git clone https://github.com/{YOUR_GITHUB_USERNAME}/acm-fun.git
  • After cloning, do not forget to create a new branch for your changes, you can do so by running:
    git checkout -b YOUR_BRANCH_NAME

3. Install Dependencies ⬇

  • Navigate to your project directory.
  • Open your terminal and run:
  npm install
  • This will install all the required node dependencies.

4. Make the desired changes 📖

  • Once you have installed the required dependencies, you can proceed with demonstrating your skills. Make the desired changes leveraging your knowledge in the tech stacks.
  • To run the project
npm start
  • To build for production
npm run build
  • closely follow the directory structure while you show your magic.

5. Commit Time! 🔼

  • Once you've added and edited your content, it's time to contribute!
  • Use the following Git commands to add, commit, and push your changes:
    git add .
    git commit -m "YOUR_NAME: COMMIT MESSAGE"
    git push -u origin YOUR_BRANCH_NAME
  • Now, go back to your GitHub fork and open a Pull Request (PR). We'll review your contribution and, if all is well, merge it into the main project.

🎊 Congratulations! 🎊 You've just made your contribution to the world of fun and games.

Happy contributing! 📚✍️