Skip to content

contributing.md

Latest commit

 

History

History
68 lines (47 loc) · 2.76 KB

contributing.md

File metadata and controls

68 lines (47 loc) · 2.76 KB
Raw

Contributing to GitHubStreak

  1. Fork the Repository
    Click the "Fork" button at the top right of this page to create your own copy of the repository.

  2. Clone Your Fork
    Run the following command to download your fork to your local machine:

    git clone https://github.com/your-username/githubstreak.-me-.git

  3. Setting up Environment Variables

  4. Create a new file named .env in the root directory of the project.

  5. Copy the contents of .env.example into the new .env file.

  6. Replace the placeholder values with your own credentials and configuration settings.

Note: The .env file should never be committed to version control, as it contains sensitive information.

  1. Create a New Branch
    Switch to a new branch where you’ll make your changes:

    git checkout -b your-branch-name

  2. Make Your Changes
    Edit the code as needed and commit your changes with a clear, concise message:

    git commit -m "Describe your changes here"

  3. Push Your Changes
    Upload your changes to your fork on GitHub:

    git push origin your-branch-name

  4. Submit a Pull Request
    Go to the original repository on GitHub and open a pull request from your fork. Provide a clear description of your changes and why they are necessary.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please read it carefully before making any contributions.

Coding Style and Conventions

  • Follow the Airbnb JavaScript Style Guide for JavaScript code.
  • Use consistent naming conventions and follow the existing project structure.
  • Write clear and concise comments to explain complex logic or sections of code.

Reporting Issues

If you encounter any bugs or have feature requests, please open a new issue on the issue tracker. When reporting a bug, please include as much detail as possible, including steps to reproduce the issue and any relevant error messages or screenshots.

Pull Requests

  1. Ensure that your code is well-documented and follows the project's coding style and conventions.
  2. Update the project's documentation if your changes introduce new features or modify existing behavior.
  3. Include relevant tests for any new functionality or bug fixes.
  4. Describe your changes in detail in the pull request description.
  5. Be responsive to feedback and questions during the review process.

License

By contributing to GitHubStreak, you agree that your contributions will be licensed under the MIT License.

Thank you for your contributions! We appreciate your efforts to make GitHubStreak better.