Skip to content

Latest commit

 

History

History
48 lines (28 loc) · 2.39 KB

Readme.md

File metadata and controls

48 lines (28 loc) · 2.39 KB

Repository Guidelines for Hacktoberfest Contributors

How to Contribute

  1. Fork the Repository: Click on the "Fork" button at the top right corner of the repository's page to create your own copy of the repository.

  2. Clone the Repository: Clone the forked repository to your local machine using the following command:

    git clone https://github.com/your-username/hacktoberfest-repo.git
    
  3. Choose a Language Folder: Inside the scripts directory, create a new folder with the name of the programming language you want to contribute to, e.g., python, java, javascript, etc.

  4. Create a New Script: Add your script to the respective language folder. Ensure your script is meaningful and well-documented.

  5. Create a README File: Inside the language folder, create a README.md file. Describe the purpose of the scripts in that language, add usage instructions, and provide any relevant information about the language itself.

  6. Commit Changes: Commit your changes with a descriptive commit message:

    git add .
    git commit -m "Add [Language] script: [Script Name]"
    
  7. Push Changes: Push your changes to your forked repository:

    git push origin master
    
  8. Submit a Pull Request: Go to the original repository on GitHub. Click on the "New Pull Request" button. Write a clear title and description for your pull request. Reference the issue you're addressing in the description.

Reporting Missing Scripts

If you want to request a script for a specific programming language that is not present in the repository, follow these steps:

  1. Create an Issue: Click on the "Issues" tab in the repository and then click on the "New Issue" button. Clearly describe the script you want and the programming language it should be in.

  2. Wait for Response: Contributors will review your issue and may choose to work on it. Feel free to discuss your requirements further in the issue comments.

  3. Contribute: If a contributor picks up your issue, they will create the script and submit a pull request. You can follow the steps mentioned above to contribute your own scripts as well.

Code of Conduct

Please adhere to our Code of Conduct while contributing. Be respectful and considerate in your interactions with other contributors.

Thank you for your contributions to Hacktoberfest! Happy coding!