Skip to content

Latest commit

 

History

History
69 lines (39 loc) · 2.45 KB

CONTRIBUTING.md

File metadata and controls

69 lines (39 loc) · 2.45 KB
Raw

Contributing Guidelines

Welcome to the Gist Manager project! We appreciate your interest in contributing. By contributing to this project, you agree to abide by the following guidelines to ensure a positive and productive experience for everyone involved.

Getting Started

Before you begin contributing, please take a moment to read and follow these guidelines:

  1. Fork the Repository:

    Fork the Gist Manager repository to your GitHub account by clicking the "Fork" button at the top-right corner of the repository page.

  2. Clone the Repository:

    Clone your forked repository to your local machine using the following command (replace <your-username> with your GitHub username):

    git clone https://github.com/gabemanfroi/gist-manager.git

  3. Create a Branch:

    Create a new branch for your contributions using a descriptive name, for example:

    git checkout -b feature/new-feature

  4. Make Changes:

    Make your desired changes or additions to the codebase, documentation, or any other project files.

  5. Test Your Changes:

    Ensure that your changes are thoroughly tested. If your contribution involves code changes, run any relevant tests and make sure they pass.

  6. Commit Your Changes:

    Commit your changes with a clear and concise commit message:

    git commit -m "Add new feature"

  7. Push Your Changes:

    Push your changes to your forked repository:

    git push origin feature/new-feature

  8. Create a Pull Request (PR):

    Open a pull request from your forked repository to the main Gist Manager repository. Provide a clear title and description for your PR, explaining the purpose of your contribution.

Code of Conduct

Please note that Gist Manager follows a Code of Conduct. We expect all contributors to adhere to this code in all project interactions.

Reporting Issues

If you encounter any issues, bugs, or have suggestions for improvements, please open an issue on the GitHub issue tracker. When reporting an issue, provide as much detail as possible to help us understand and address the problem.

Contribution License

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

Thank you for contributing to Gist Manager! Your contributions help make this project better for everyone.