Skip to content

Latest commit

 

History

History
105 lines (72 loc) · 6.75 KB

CONTRIBUTING.md

File metadata and controls

105 lines (72 loc) · 6.75 KB
Raw

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. If you have suggestions for improving the code, your insights will be highly welcome. In order to contribute to this project, please follow the guidelines below or read the CONTRIBUTING.md file for more details on how to contribute to this project, as it contains information about the commit standards and the entire pull request process. Please follow these guidelines to make your contributions smooth and effective:

Step 1: Set Up Your Environment

Before you can contribute, you need to set up your development environment. This steps are already explained in the Setup section.

Step 2: Make Your Changes

Now that your environment is set up, you're ready to start making changes. It's a good idea to start with a clear goal in mind. Are you fixing a bug, adding a feature, or improving documentation?

  1. Create a Branch: Before diving into code changes, start by creating a new branch for your updates. This strategy helps keep your modifications neatly organized and distinct from the main project line, facilitating a smoother integration and review process later on. Choose a branch name that is both descriptive and reflective of the changes you're proposing.

    git checkout -b feature/AmazingFeature

  2. Make Your Changes: With your branch ready, you can now focus on implementing your proposed changes, be it additions, modifications, or fixes. Here are some key points to keep in mind during this stage:

    • Test Thoroughly: Ensure your changes work as intended and don't introduce new problems. Adequate testing is crucial for maintaining the integrity and reliability of the project.

    • Commit Wisely: Large changes can make the review process daunting. Aim to break down big updates into smaller, more manageable commits. This approach not only eases the review process but also keeps the project history clear and understandable.

    • Follow Standards: Adhere to the project's coding conventions and standards. Consistency in coding practices ensures code readability and eases maintenance for all contributors. If you want to know a great commit standards, read the convention below, which is very similar to the Conventional Commits specification.

Crafting Your Commit Messages

Your commit messages play a vital role in documenting the project's development history. They should be clear, concise, and informative. Here are some common types of commits and how to format their messages effectively:

  • Features: Introducing new features.

    FEAT: Add <FeatureName>

  • Bug Fixes: Resolving issues or errors.

    FIX: Resolve <IssueDescription>. Closes #<IssueNumber>

  • Documentation: Updating or adding to the documentation, including both code comments and README files.

    DOCS: Update <Section/Topic> documentation

  • Refactor: Enhancing the code without changing its functionality, usually for readability, efficiency, or structure improvements.

    REFACTOR: Enhance <Component> for better <Aspect>

  • Snapshot: Temporarily saving the current state of the project. Useful for marking specific points in development or experimentation and save it into git instead of simply using your IDE Stash feature, which is not visible to others and can be lost if not properly managed.

    SNAPSHOT: Temporary commit to save the current state for later reference

Navigating Commits

If you need to revert to a previous state after making a snapshot or any commit, you can use the following commands:

  • To undo the last commit and return your workspace to the state just before that commit (keeping your changes in the working directory): 
    git reset --soft HEAD^
  • To completely remove the last commit, including all changes (use with caution): 
    git reset --hard HEAD^

These commands are invaluable for refining your contributions, allowing you to adjust your approach before finalizing your commit.

By following these guidelines for your commits, you help ensure that your contributions are easily integrated and appreciated by the project team and community.

  1. Commit Your Changes: After making sure your changes are thorough and well-organized, commit them to your branch. Use clear and concise commit messages that accurately describe the changes you've made and their impact on the project. 
    git commit -m "FEAT: Add some AmazingFeature"

Remember, the quality of your commits and their messages significantly affects the review process and the overall development flow. It's always worth taking the extra time to review your changes and craft meaningful commit messages.

Step 3: Submit Your Contribution

After making your changes, you're ready to contribute them back to the original project.

  1. Push to GitHub: Push your changes to your fork on GitHub. 
    git push origin feature/AmazingFeature
  2. Open a Pull Request: Go to the original repository on GitHub, and you should see a prompt to open a pull request from your new branch. Click the "Compare & pull request" button to begin the process.
  3. Describe Your Changes: Provide a title and detailed description of your changes in the pull request. Explain the rationale behind your changes, any issues they address, and any testing you've performed.
  4. Submit the Pull Request: Submit your pull request. The project maintainers will then review your contribution. Be open to feedback and ready to make further tweaks or improvements based on their suggestions.

Step 4: Stay Engaged

After submitting your pull request, stay engaged in the conversation. The project maintainers may have questions or request changes before your contribution can be merged.

  • Respond to Feedback: Be responsive to comments and feedback from the project's maintainers. If changes are requested, make them promptly and update your pull request.
  • Update Your Branch if Needed: If your pull request has conflicts with the base branch, you may need to update your branch. You can do this by merging or rebasing your branch with the latest version of the base branch.

Step 5: Celebrate Your Contribution

Once your pull request has been reviewed and merged, your contribution is now part of the project! Be proud of your work and celebrate your contribution to the open-source community.

By following these steps, you can contribute effectively to projects and make a positive impact on the open-source ecosystem. Thank you for contributing!