Skip to content

Latest commit

 

History

History
177 lines (117 loc) · 12.5 KB

CONTRIBUTING.md

File metadata and controls

177 lines (117 loc) · 12.5 KB
Raw

Contributing to ByConity

Thanks for taking the time to contribute to ByConity! 💙💙💙

All types of contributions are encouraged and valued. There are many ways to contribute beyond code. See the Table of Contents for different ways to help and details about how the ByConity project handles them. Please make sure to read the relevant sections before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions! 🎉

Please give us any feedback if you need any help with anything including(and beyond):

  • Problems found during setting up a new developer environment
  • Gaps in our Quickstart Guide or documentation
  • Bugs in our automation scripts

If anything doesn't make sense, or doesn't work when you run it, please open a bug report and let us know!

And if you like ByConity, but just don't have time to contribute, that's fine. There are other easy ways to support ByConity and show your appreciation, which we would also be very happy about:

  • Star the repository ⭐️
  • Tweet about ByConity 🐦
  • Refer to ByConity in your project's readme 🤝
  • Mention ByConity at local meetups, conferences, events and tell your friends/colleagues 🗣️

Table of Contents

Code of Conduct

This project and everyone participating in it are governed by the ByConity Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to our Developer Advocates @joshalphonse and @vinijaiswal

I Have a Question

If you want to ask a question, we assume that you have read the available Documentation.

Before you ask a question, it is best to search for existing Issues that might help you. If you have found a suitable issue and still need clarification, you can write your question about this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

  • Open an Issue.
  • Provide as much context as you can about what you're running into.
  • Provide project and platform versions, depending on what seems relevant.
  • Use our Discord server to reach the community

We will then take care of the issue as soon as possible.

I Want To Contribute

Legal Notice

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content, and that the content you contribute may be provided under the project license.

We welcome many different types of contributions including:

  • New features
  • Builds, CI/CD
  • Bug fixes
  • Documentation
  • Issue Triage
  • Answering questions on Discord/Mailing List
  • Web design
  • Communications/ Social Media/ Blog Posts
  • Release management

Not everything happens through a GitHub pull request. Please join the community on Discord or create a discussion on GitHub and let's discuss how we can work together.

Reporting Bugs

Before Submitting a Bug Report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information, and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.

  • Make sure that you are using the latest version.

  • Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the documentation. If you are looking for support, you might want to join our Discord Server and ask the community.

  • To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.

  • Also, make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.

  • Collect information about the bug:

    • Stack trace (Traceback)
    • OS, Platform, and Version (Windows, Linux, macOS, x86, ARM)
    • A version of the interpreter, compiler, SDK, runtime environment, and package manager, depending on what seems relevant.
    • Possibly your input and the output
    • Can you reliably reproduce the issue? And can you also reproduce it with older versions?

How Do I Submit a Good Bug Report?

You must never report security-related issues, vulnerabilities, or bugs, including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to byconity.global@bytedance.com.

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

  • Open an Issue. (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
  • Explain the behavior you would expect and the actual behavior.
  • Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports, you should isolate the problem and create a reduced test case.
  • Provide the information you collected in the previous section.

Once it's filed:

  • The project team will label the issue accordingly.
  • A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as needs-repro. Bugs with the needs-repro tag will not be addressed until they are reproduced.
  • If the team is able to reproduce the issue, it will be marked help wanted, as well as possibly other tags (such as critical).

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for ByConity, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

Before Submitting an Enhancement

  • Make sure that you are using the latest version.
  • Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration.
  • Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
  • Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.

How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Describe the current behavior and explain which behavior you expected to see instead and why. At this point, you can also tell which alternatives do not work for you.
  • You may want to include screenshots and animated GIFs which help you demonstrate the steps or point out the part to which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
  • Explain why this enhancement would be useful to most ByConity users. You may also want to point out the other projects that solved it better and which could serve as inspiration.

Sign Your Commits

We require that contributors have signed our Contributor License Agreement (CLA) in order for us to accept patches and other contributions from you. By singning the CLA you state the following:

  • You obviously wish and are willingly licensing your contributions to us for our open source projects under the terms of the CLA,
  • You have read the terms and conditions of the CLA and agree with them in full,
  • You are legally able to provide and license your contributions as stated,
  • We may use your contributions for our open source projects and for any other our project too,
  • We rely on your assurances concerning the rights of third parties in relation to your contributions.

If you agree with these principles, please read and adopt our CLA. By providing us your contributions, you hereby declare that you have already read and adopt our CLA, and we may freely merge your contributions with our corresponding open source project and use it in further in accordance with terms and conditions of the CLA.

If you have already adopted terms and conditions of the CLA, you are able to provide your contributes. When you submit your pull request, please add the following information into it:

I hereby agree to the terms of the CLA available at:

Replace the bracketed text as follows:

It is enough to provide us such notification once.

As an alternative, you can provide DCO instead of CLA. You can find the text of DCO here: https://developercertificate.org/ It is enough to read and copy it verbatim to your pull request.

If you don't agree with the CLA and don't want to provide DCO, you still can open a pull request to provide your contributions.

Pull Request Checklist

When you submit your pull request, or you push new commits to it, our automated systems will run some checks on your new code. We require that your pull request passes these checks, but we also have more criteria than just that before we can accept and merge it. We recommend that you check the following things locally before you submit your code:

Before you submit your Pull Request (PR) consider the following guidelines:

  1. Search GitHub for an open or closed PR that relates to your submission. You don't wan to recreate something that was already added

  2. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design upfront helps to ensure that we're ready to accept your work.

  3. Please sign our Contributor License Agreement (CLA) before sending PRs. We can not accept code without a signed CLA. Make sure you author all contributed Git commits with the email address associated with your CLA signature.

  4. Fork the ByConity/ByConity repo.

  5. in your forked repository, make your changes in a new git branch:

    git checkout -b my-fix-branch master

  6. Create your patch, including appropriate test cases .

  7. Run the full ByConity test suite, as described in the developer documentation, and ensure that all tests pass.

  8. Commit your changes using a descriptive commit message that follows our commit message conventions (place those here). Adherence to these conventions is necessary because release notes are automatically generated from these messages.

  9. git commit --all

  10. Note: the optional commit -a command line option will automatically "add" and "rm" edited files.

  11. Push your branch to GitHub:

  12. git push origin my-fix-branch

  13. On GitHub, send a pull request to ByConity:master.