github.com/machinefi/w3bstream@v1.6.5-rc9.0.20240426031326-b8c7c4876e72/CONTRIBUTING.md (about)

     1  ## Code Contribution Guidelines
     2  
     3  Thank you for your interest in contributing to our project! We welcome contributions from the community to help improve the codebase. To ensure a smooth and collaborative development process, please follow the guidelines below when submitting your code contributions.
     4  
     5  ### Getting Started
     6  
     7  1. Fork the repository on GitHub by clicking on the "Fork" button at the top of the repository's page.
     8  2. Clone your forked repository to your local machine using the following command:
     9  `git clone https://github.com/machinefi/w3bstream.git`
    10  3. Navigate to the project's directory:
    11  `cd w3bstream`
    12  4. Create a new branch to work on your changes:
    13  `git checkout -b my-feature`
    14  
    15  ### Creating an Issue
    16  
    17  1. Before starting your work, it's recommended to create an issue describing the problem you want to address or the feature you plan to implement.
    18  2. Go to the "Issues" tab on the original repository and click on "New issue."
    19  3. Provide a clear and descriptive title for the issue.
    20  4. Write a detailed description of the problem or feature, including motivation and any relevant context or examples.
    21  
    22  ### Making Changes
    23  
    24  1. Before making any changes, ensure that you have pulled the latest changes from the upstream repository:
    25  `git pull origin main`
    26  2. Make the necessary changes or additions to the codebase.
    27  3. Write tests to ensure the correctness and maintainability of your changes.
    28  4. Ensure that your code follows the project's coding style and conventions.
    29  5. Commit your changes with a clear and descriptive commit message:
    30  `git commit -m "Add my feature: a brief description"`
    31  
    32  ### Submitting the Contribution
    33  
    34  1. Push your changes to your forked repository:
    35  `git push origin my-feature`
    36  2. Visit the original repository on GitHub and click on the "Compare & pull request" button.
    37  3. Provide a clear and concise title for your pull request, along with a detailed description of the changes you have made.
    38  `Title format: [FEAT/BUGFIX/ENH/DOC/TEST] (Component) Title`
    39  4. In the pull request description, reference the issue you created earlier using the issue number (e.g., "Fixes #123").
    40  5. Add appropriate tags to your pull request, such as 'fix bug', 'new feature', 'enhancement', or any other relevant tags that describe the nature of your changes.
    41  6. Explain the code changes and their purpose, providing any necessary context or technical details to help reviewers understand your code.
    42  7. Submit the pull request, and it will be reviewed by the project maintainers.
    43  8. Be prepared to receive feedback and address any requested changes.
    44  
    45  ### Code Contribution Tips
    46  
    47  - Please make sure your changes are focused and well-contained, addressing a specific issue or implementing a particular feature.
    48  - Keep your commits atomic and logical, making it easier for the reviewers to understand your changes.
    49  - Follow the project's documentation and coding guidelines to maintain consistency across the codebase.
    50  - Write meaningful and comprehensive test cases to cover your changes and ensure code quality.
    51  - Be responsive to feedback and engage in constructive discussions during the review process.
    52  - Have patience, as it may take some time for your pull request to be reviewed. We appreciate your understanding.
    53  
    54  Thank you for your contribution, and we look forward to reviewing your code changes!
    55