Skip to content

Latest commit

 

History

History
81 lines (56 loc) · 4.05 KB

CONTRIBUTING.md

File metadata and controls

81 lines (56 loc) · 4.05 KB

Contributing Guidelines

Thank you for your interest in contributing to babylon-nginx!

Clarification on GitHub Issue Usage and Feature Requests

We want to clarify that Github Issues are primarily meant for the purpose of reporting problems or concerns, rather than functioning as an open bug tracker. This means that reported issues on Github may be closed and reported in our internal tracking system or added to our roadmap.

If you are thinking of requesting a feature, make sure it’s not already part of our upcoming features outlined in the Roadmap. If you have a feature suggestion, we kindly ask that you share it through Discord or Telegram.

Our primary focus is on the priorities outlined in our Roadmap. We appreciate your understanding that addressing reported issues may not always align with our immediate roadmap goals.

Table of Contents

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Reporting Issues

Ensure the bug was not already reported by searching on GitHub under Issues.

If you encounter a bug or have a problem with the project, please open an issue on our issue tracker. Make sure to provide as much detail as possible, including:

  • A clear and descriptive title.
  • Steps to reproduce the issue.
  • Expected behavior and actual behavior.
  • Your operating system, browser, or other relevant information.
  • If possible, include screenshots or code snippets that illustrate the issue.

Contributing Code

Submitting a Pull Request does not guarantee the acceptance of your proposed changes. We strongly advise initiating a discussion with the team via Discord, Telegram, or Github Issues (for bugs) prior to commencing work on a PR.

Setting Up Your Development Environment

Note: adapt this as required for your repository

  1. Fork the repository to your GitHub account.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your changes.

Making Changes

  1. Write clear, concise, and well-documented code.
  2. Commit your changes with a descriptive commit message. Please follow the PROJECT’s commit message format.

Testing

Note: adapt this as required for your repository

  1. Ensure that your changes do not break existing tests.
  2. Write new tests for your code if applicable.
  3. Run the test suite to make sure everything is passing.

Submitting a Pull Request

Note: adapt this as required for your repository (the target branch for the PR may change)

  1. Push your changes to your forked repository:
  2. Open a pull request against the develop branch of the original repository.
  3. Provide a clear and informative title and description for your pull request.
  4. Be prepared to address any feedback or questions during the review process.

Review Process

Pull requests will be reviewed by project maintainers. Reviewers may provide feedback, request changes, or approve the pull request. We appreciate your patience during this process, and we aim to be responsive and constructive in our feedback.

License

By contributing to babylon-nginx, you agree that your contributions will be licensed under the Radix License 1.0 (modified Apache 2.0):.