Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
92 lines (53 loc) · 3.66 KB

CONTRIBUTING.md

File metadata and controls

92 lines (53 loc) · 3.66 KB

Contributing to Apache ServiceComb Samples

Thank you for your interest in contributing to the Apache ServiceComb Samples project. Your contributions can help improve and expand the samples and examples provided with Apache ServiceComb. To ensure a smooth and collaborative experience, please follow the contribution guidelines outlined below.

Submitting Contributions

To contribute to this project, please follow these steps:

1. Choose or Create an Issue

  • Start by reviewing the existing issues to identify areas where your contributions can make a significant impact.
  • If you have new sample ideas, enhancements, or bug fixes in mind, you can create a new issue to propose your contributions. Please provide comprehensive details to clearly explain your ideas.

2. Fork the Repository

  • To initiate your contribution, fork the primary repository by clicking the "Fork" button. This creates a copy of the repository in your personal GitHub account.

3. Clone Your Forked Repository

  • Clone your forked repository to your local development environment using the following command:
git clone https://github.com/your-username/servicecomb-samples.git

4. Set Up the Upstream Remote

  • Keep a reference to the primary project by adding it as the upstream remote:
cd servicecomb-samples
git remote add upstream https://github.com/apache/servicecomb-samples
git remote -v

5. Create a New Branch

  • Before you start working on your contribution, create a new branch dedicated to your specific sample or task:
git checkout -b my-contribution

Working on Your Contribution

Now that your development environment is set up and a new branch is created, you can begin working on your contribution. Please follow these guidelines:

6. Make Changes

  • Implement the necessary changes, including adding or updating sample code, enhancing existing samples, or fixing bugs. Ensure that your contributions are well-structured and documented, aligning with the project's objectives.

7. Commit Your Changes

  • Commit your changes with informative commit messages that clearly explain the purpose of your contributions:
git commit -m "Add a descriptive message here"

8. Push Your Changes

  • Push the committed changes to your remote repository on GitHub:
git push origin my-contribution

9. Create a Pull Request

  • Visit your repository on GitHub and click the "New Pull Request" button to initiate a pull request from your branch to the primary repository.

10. Await Review

  • Your pull request will undergo review, and feedback will be provided by the project maintainers or fellow contributors. Be prepared to address any suggested changes or refinements.

Community Engagement

While contributing, consider engaging with the community in the following ways:

11. Join Discussions

  • Participate in discussions related to Apache ServiceComb Samples, share your insights, and collaborate with others to enhance the quality of the provided samples and examples.

12. Share Ideas

  • If you have innovative ideas for new samples, improvements, or better ways to demonstrate Apache ServiceComb features, don't hesitate to open issues to initiate productive discussions.

Acknowledgment

We appreciate your interest in improving Apache ServiceComb Samples. Your contributions are valuable for the project's growth and success. If you have questions or need assistance, please feel free to contact the project maintainers.

Thank you for your valuable contributions, and we look forward to collaborating with you on the Apache ServiceComb Samples project! 🚀📦🙌