Skip to content

Latest commit

 

History

History
138 lines (96 loc) · 5.99 KB

CONTRIBUTING.md

File metadata and controls

138 lines (96 loc) · 5.99 KB
Raw

Contributing to GO Feature Flag

Thank you for considering contributing to this repository!
You will contribute to the coolest Opensource Feature Flag solution and be part of an awesome community 😜.

We welcome contributions to improve and grow this project.
Please take a moment to review the following guidelines.

Table of Contents

  1. Code of Conduct
  2. How Can I Contribute?
  3. Where can I ask questions about the project?
  4. Development Setup
  5. Documentation
  6. License

🚓 Code of Conduct

We expect all contributors to abide by our Code of Conduct.
Please read it thoroughly before contributing.

🙇 How Can I Contribute?

Bug Reports

If you encounter any bugs or issues with the project, please create a new issue and include as many details as possible, such as:

  • A clear and descriptive title
  • Steps to reproduce the bug
  • Expected behaviour and actual behaviour
  • Your operating system and version
  • The version of the project you were using when the bug occurred
  • Any relevant error messages or logs

Feature Requests

If you have a feature idea that you would like to see implemented, please create a new issue with the following information:

  • A clear and descriptive title
  • A detailed description of the feature
  • Any additional context that may be relevant

Pull Requests

We welcome contributions in the form of pull requests.

Before opening a pull request, we kindly request you check if there is an open issue related to your proposed contribution. By doing so, we can initiate a discussion and provide feedback on your changes before proceeding with the pull request. This approach ensures that your efforts align with the project's goals and enhances the chances of your contribution being successfully integrated. Thank you for your understanding and cooperation!

If you want to take an issue that is already open, please follow those steps:

  1. Check that the issue is not assigned.
  2. Assign the issue to yourself by adding a comment on the issue containing the text /assign-me.
  3. This will assign you the issue automatically.
  4. After 10 days the assignment will be removed, if you need more time to work on it add a comment on the issue.

To submit a pull request, follow these steps:

  1. Fork the repository to your GitHub account.
  2. Create a new branch from the main branch.
  3. Make your changes.
  4. Test your changes thoroughly.
  5. Commit your changes with a clear and descriptive commit message.
  6. Push your branch to your forked repository.
  7. Open a pull request, comparing your branch to the main branch of this repository.
  8. Provide a detailed description of your changes in the pull request.

We will review your pull request as soon as possible Please be patient, as it might take some time for us to get back to you Your contributions are highly valued!

🧑‍💻 Development Setup

We always strive to keep the project as simple as possible, so you will find everything you need in the Makefile at the root of the repository.

To start contributing please set up your GO environment and run:

make vendor

It will download the dependencies and your project will be ready to be used.

Coding standards

It is easier for contributors to work on the same project if it has a consistent, unified style, approach, and layout.

To help with that, we are using pre-commit to lint before each commit, I would recommend you to install it, and to apply it to the project by running:

pre-commit install

Tests

Every feature or bug should come with an associate test to keep the coverage as high as possible. We aim to have 90% of coverage for the project.

🤔 Where can I ask questions about the project?

If you want to contribute and you have any questions you can use different ways to contact us.

  1. You can create an issue and ask your question - Create an issue.
  2. You can join the #go-feature-flag channel in the gopher slack.
    To join:
  3. Send us an email to contact@gofeatureflag.org

📚 Documentation

We are maintaining 2 documentations:

  • README.md which contains everything you need to know to start working with the module.
  • go-feature-flag website which is the full detail website containing the documentation.

If your contribution has an impact on the documentation, please check both versions. You can check how to work on the documentation here.

How to run the documentation website locally

For the documentation website, we are using Docusaurus 2.
Everything is available in the website/docs directory.

You can start locally the website.

  1. Open a terminal and go to the root project of this repository.
  2. Launch the command below, it will install the dependencies and run the local server for the documentation.
make watch-doc
  1. You can now access to the documentation directly in your browser: http://localhost:3000/.

🪪 License

By contributing to this repository, you agree that your contributions will be licensed under the LICENSE of the project.

📊 Stats

If you want to check the stats of GO Feature Flag you can have a look at https://github-repo-stats--goff-github-stats.netlify.app/report.html

We encourage everyone to participate in this project and make it better for everyone. Happy contributing 🎉