gitlab-org / coming-soon

Contributing to GitLab’s “Coming Soon” Feature

This guide provides a comprehensive overview of how you can contribute to the “Coming Soon” feature in GitLab, hosted at https://gitlab.com/gitlab-org/coming-soon/.

While the project doesn’t currently have a formal contributing guide, this resource aims to equip you with the necessary knowledge and steps to make meaningful contributions.

Understanding the Project

The “Coming Soon” feature within GitLab is a core component that enables users to announce upcoming features or functionalities within their projects. It serves as a valuable tool for managing expectations and fostering engagement.

Key Concepts

  • message: This attribute defines the text message displayed on the “Coming Soon” page.
  • documentation_url: This attribute holds the link to documentation or resources providing further information about the feature.
  • status: This attribute indicates the current state of the feature, often categorized as “planned,” “in-progress,” or “released.”

Contributing to the Project

  1. Fork the Repository: Begin by forking the GitLab repository to your personal account. This creates a copy you can work with independently.

  2. Clone your Fork: Clone your forked repository to your local machine using the following command:

git clone [email protected]:your-username/coming-soon.git
  1. Create a Branch: Before making any changes, create a new branch for your contribution:
git checkout -b feature/your-contribution-name
  1. Make Changes: Implement your contribution based on the project’s existing code and functionalities. The following commands provide potential starting points:
  • Build: Use make build to compile the source code and generate the binary.
  • Run: Execute the binary using ./<binary_name> to test your changes.
  • Test: Run tests to ensure your changes don’t introduce regressions. You can use make test for all tests or make test <test_file> for specific tests.
  • Lint: Verify code style and syntax using make lint.
  1. Commit Your Changes: Once you’ve finalized your changes, commit them to your branch using a descriptive message:
git add .
git commit -m "Your commit message describing the changes"
  1. Push Your Branch: Push your branch to your forked repository on GitLab:
git push origin feature/your-contribution-name

  1. Open a Merge Request: Create a merge request from your branch into the main branch of the original repository. This triggers a review process, allowing other developers to evaluate your changes and provide feedback.

  2. Address Feedback: Review comments and suggestions from reviewers and implement any necessary modifications to your contribution.

  3. Merge Request Approved: Once your merge request is approved and merged, your changes will be incorporated into the official GitLab repository.

Additional Tips

  • Communication: Engage with the GitLab community through the project’s issue tracker and discussion boards to understand ongoing work and potential areas for contribution.
  • Code Style: Adhere to the project’s existing code style and conventions for a seamless integration of your contribution.
  • Testing: Thoroughly test your changes to ensure they work correctly and don’t cause any issues.
  • Documentation: Update documentation if your changes introduce new features or modifications to existing functionalities.

Conclusion

Contributing to GitLab’s “Coming Soon” feature empowers you to directly influence the platform’s development and enhance its capabilities. By following these steps and engaging with the community, you can make a positive impact on the GitLab ecosystem.