Skip to content

Latest commit

 

History

History
186 lines (134 loc) · 7.77 KB

CONTRIBUTING.md

File metadata and controls

186 lines (134 loc) · 7.77 KB
Raw

Cardinal Components API Contribution Guidelines

We like to encourage you to contribute to the Cardinal Components repository. This should be as easy as possible for you but there are a few things to consider when contributing. The following guidelines for contribution should be followed if you want to submit a pull request or open an issue.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.

Table of Contents

TLDR;

  • Creating an Issue or Pull Request requires a GitHub account.
  • Issue reports should be clear, concise and reproducible. Check to see if your issue has already been resolved in the current branch or already reported in Cardinal Components' GitHub Issue Tracker.
  • Pull Requests must adhere to the project's coding style guidelines.
  • IMPORTANT: By submitting a patch, you agree to allow the project owner to license your work under the same license as that used by the project.

Contributing

The issue tracker is the preferred channel for bug reports, feature requests and submitting pull requests, but please respect the following restrictions:

  • Please do not use the issue tracker for personal support requests (you can ask well-formed questions in adequate channels on the Fabric Discord or on the Ladysnake Discord).
  • Please do not derail or troll issues. Keep the discussion on topic and respect the opinions of others

Bug Reports

A bug is a demonstrable problem that is caused by the code in the repository.

Guidelines for bug reports:

  1. Use the GitHub issue search — check if the issue has already been reported.
  2. Check if the issue has been fixed — try to reproduce it using the latest master or development branch in the repository.
  3. Isolate the problem — create a test case to demonstrate your issue. Provide either a repo, gist, or code sample to demonstrate your problem.

A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What Minecraft and/or Fabric versions experience the problem? What would you expect to be the outcome? All these details will help people to fix any potential bugs.

Example:

Short and descriptive example bug report title

A summary of the issue and the MC environment in which it occurs. If suitable, include the steps required to reproduce the bug.

  1. This is the first step
  2. This is the second step
  3. Further steps, etc.

<url> - a link to the reduced test case OR

EntityComponents.setRespawnStrategy((from, to, lossless, keepInventory) -> {});
// code sample

Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).

Feature Requests

Feature requests are welcome. But take a moment to 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. Please provide as much detail and context as possible.

Pull Requests

  • PRs adding significant maintenance burden are advised against.
  • PRs for bug fixes are always welcome.
  • PRs for enhancing the interfaces are always welcome.
  • PRs that increase test coverage are always welcome.

Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.

Please adhere to the coding conventions used throughout a project (indentation, accurate comments, etc.) and any other requirements (such as test coverage). Please review the Cardinal Components Coding Style Guide.

Follow this process if you'd like your work considered for inclusion in the project:

  1. Fork the project, clone your fork, and configure the remotes:
# Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/<repo-name>
# Navigate to the newly cloned directory
cd <repo-name>
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/<upstream-owner>/<repo-name>
  1. If you cloned a while ago, get the latest changes from upstream:
git checkout <dev-branch>
git pull upstream <dev-branch>
  1. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:
git checkout -b <topic-branch-name>

  1. Commit your changes in logical chunks. Use Git's interactive rebase feature to tidy up your commits before making them public.

  2. Run you code to make sure it works.

gradlew build
  1. Locally merge (or rebase) the upstream development branch into your topic branch:
git pull [--rebase] upstream <dev-branch>
  1. Push your topic branch up to your fork:
git push origin <topic-branch-name>
  1. Open a Pull Request with a clear title and description.

IMPORTANT: By submitting a patch, you agree to allow the project owner to license your work under the same license as that used by the project.

Releasing

Anyone who is a core contributor can publish a release:

  1. Go to the Releases page on Github
  2. Hit "Draft a new release" (if you can't see this, you're not a core contributor!)
  3. Write human-friendly Release Notes based on changelog.
  • The release title is "x.x.x" (where x.x.x is the version number)
  • If breaking changes, write migration tutorial(s) and reasoning.
  • Callouts for community contributions (PRs) with links to PR and contributing user.
  • Callouts for other fixes made by core contributors with links to issue.
  1. Hit "Save Draft" and get other core contributors to check your work, or alternatively hit "Publish release"
  2. That's it!

Support

Resources

For most of the documentation you are going to want to look at the README.

Core Contributors

Feel free to reach out to any of the core-contributors with you questions or concerns. We will do our best to respond in a timely manner.

  • UpcraftLP
  • Pyrofab
    • GitHub: @Pyrofab
    • Discord: Pyrofab#2068



Contributing guidelines based on ChaiJS'