diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index a2a631c..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,188 +0,0 @@ -# Contributing - -Before opening an issue or submitting a pull request, please read through this -document to familiarize yourself with the development process. - -## Issue Tracker - -The [issue tracker](https://github.com/vezel-dev/zig-sdk/issues) is where all -bug reports and feature requests should be posted. Other community areas are not -appropriate for these as issues raised there are likely to be lost or forgotten. - -Please respect the following points when posting on the issue tracker: - -* Do not post support requests or questions. Check [`SUPPORT.md`](SUPPORT.md) to - find better channels for these. -* Do not violate - [GitHub's various site policies](https://docs.github.com/en/github/site-policy). -* Do not post off-topic comments or otherwise derail a discussion. - -Issues and/or comments violating these rules may be deleted. Repeated violations -may lead to -[interaction limits](https://docs.github.com/en/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository) -being enacted. - -### Labels - -We use labels to organize issues on the GitHub issue tracker. A full list of -labels can be found [here](https://github.com/vezel-dev/zig-sdk/labels), along -with descriptions of each. Here are a few guidelines for how issue labels are to -be applied: - -* An issue should have exactly one `type` and one `state` label. - * The `type` label should generally never change throughout an issue's - lifetime, mislabeling notwithstanding. - * The `state` label is expected to change multiple times as the issue - progresses. -* An issue should have at least one `area` label. - * Labels of this type can be removed to correct inaccuracies, but they - should not be removed if an issue is being addressed incrementally in - different areas; instead, comment on the issue to indicate that a - particular area has been addressed. - -### Milestones - -We use milestones to plan future versions of the project. When we triage an -issue, we will assign a milestone based on a rough guesstimation of the -difficulty and urgency of the issue, as well as other factors (such as whether -fixing the issue constitutes a breaking change). It is normal for an issue to -have its milestone changed if the initial guesstimation turned out to be -inaccurate (in either direction). - -A full list of milestones can be found -[here](https://github.com/vezel-dev/zig-sdk/milestones). - -### Bug Reports - -The ideal bug report is one that is immediately actionable by a person looking -to resolve it. To that end, a bug report should include: - -* The version of the Zig SDK being used. -* The version of the Zig toolset being used. -* Information about host and target platforms (operating system, architecture, - etc). -* A self-contained test case that reproduces the issue, along with instructions - to trigger the issue. -* A detailed description of current behavior (including stack traces(s) if - applicable) and expected behavior. - -Basically, try your best to ensure that fixing the bug will not require us to -ask you for further information. This makes it more likely for the bug to be -fixed in a timely fashion. Of course, in some cases, clarification and -discussion is necessary due to unexpected factors or sheer complexity. - -### Feature Requests - -Feature requests are welcome, but please note the following: - -* Take a moment to consider whether the feature really makes sense for the core - project. Many features can live as community NuGet packages. -* It is up to you to convince the maintainers that the feature should be - included. You will need to make a strong case as the bar for new features is - fairly high. -* Be as detailed as possible when describing the proposed feature. Explore - benefits and drawbacks. Consider which alternatives are available, and explain - why you believe they are insufficient. - -At the end of the day, whether a feature request is accepted is up to the -maintainers. There is no guarantee that a feature request will be accepted, no -matter how well-specified it is. Also, the maintainers do not commit to -implementing a feature request when accepting it; acceptance just means that -anyone can implement it and submit a pull request in the knowledge that the -feature is a welcome addition. - -## Pull Requests - -[Pull requests](https://github.com/vezel-dev/zig-sdk/pulls) are a great way to -contribute, whether it be code or documentation improvements. It is a good idea -to check the issue tracker to see if someone else is already working on -something before you start work on it. For feature additions, it is also -important to open a feature request on the issue tracker to see if the -maintainers are actually interested in merging it. - -### Etiquette - -While pull requests to clean up messy/hacky code (i.e. refactoring) are welcome, -we are not likely to accept pull requests that just change code style. Further, -please make sure that any code you contribute adheres to the style of the -surrounding code. The [EditorConfig](.editorconfig) file in the project should -be helpful for this, as should the `dotnet format` command. - -Please try to keep your pull request free of unrelated changes. If you need to -fix another bug in order to make your pull request work, please submit that bug -fix as a separate pull request. - -### Licensing & Copyright - -When you contribute code or documentation, you agree to make it available under -the project's licensing terms; see [`LICENSE-0BSD`](LICENSE-0BSD). - -Copyright assignment is not necessary when contributing to the project. -Individual contributors retain copyrights for their contributed code. - -### Inactivity - -If a pull request has been sitting for months with no updates from the author, -we may choose to close it. This is to avoid cluttering the pull request queue, -which could lead to other pull requests being lost. If your pull request is -closed due to inactivity, you are always welcome to reopen it if/when you have -time to address any issues that were brought up on it. - -We do our best to review all pull requests in a timely fashion, but since the -maintainers have limited time, we may sometimes take a while to review a pull -request. If your pull request has not received a review for a week or more, feel -free to ping relevant individuals on the pull request. - -### Reommended Process - -The first thing you need to do is -[fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo). - -Once you have a forked repository, clone and set it up locally: - -```bash -# Replace with your GitHub user name. -git clone git@github.com:/zig-sdk.git -cd zig-sdk -# Set up a remote pointing to the upstream repository. -git remote add upstream git@github.com:vezel-dev/zig-sdk.git -``` - -Whenever you need to update your fork, do something like this: - -```bash -git checkout master -# Rebase when pulling to avoid creating merge commits if you have commits that -# have not yet yet been upstreamed. -git pull --rebase upstream master -``` - -We recommend that you use a feature branch for each individual change, feature, -or fix that you work on: - -```bash -# Replace with a name that makes sense for your work. -git checkout -b -``` - -At this point, you can start making changes and committing them. It is good form -to clean up your commit history to make it easier to review (e.g. if you had to -do small fixups to a commit, squash them into that commit). See -[this article](https://docs.github.com/en/get-started/using-git/about-git-rebase) -for more information. - -You may need to rebase your feature branch on top of upstream `master` every now -and then. Use `git pull --rebase upstream master` as shown above. Please always -use rebasing instead of creating merge commits. - -Once you are ready to publish your branch, do something like this: - -```bash -# Replace with the branch name you picked earlier. -git push origin -``` - -(You can use the `--force` option if you know what you are doing and you need to -overwrite history in your feature branch that you have already pushed.) - -Finally, you can open a pull request against the upstream `master` branch. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9c807a0..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,10 +0,0 @@ -# Security - -Please do not report vulnerabilities through the -[issue tracker](https://github.com/vezel-dev/zig-sdk/issues); instead, use the -[private vulnerability reporting](https://github.com/vezel-dev/zig-sdk/security/advisories/new) -feature. - -Once the vulnerability has been confirmed and a fix implemented, a new release -will be published. This will usually be a patch-level release unless a more -significant major/minor-level release coincides with the fix. diff --git a/SUPPORT.md b/SUPPORT.md deleted file mode 100644 index ad84079..0000000 --- a/SUPPORT.md +++ /dev/null @@ -1,22 +0,0 @@ -# Support - -Please use one of the following channels for support requests: - -[![Discussions](https://img.shields.io/github/discussions/vezel-dev/zig-sdk?color=teal)](https://github.com/vezel-dev/zig-sdk/discussions/categories/questions) -[![Discord](https://img.shields.io/discord/960716713136095232?color=peru&label=discord)](https://discord.gg/GE88ZrPg8j) - -Do *not* use the -[issue tracker](https://github.com/vezel-dev/zig-sdk/issues) for support -requests. - -When seeking help, please note the following: - -* Have a look through [`README.md`](README.md) first. -* Search GitHub and other relevant forums/channels to see if your question has - been answered already. -* Apply [rubber duck debugging](https://rubberduckdebugging.com) first. -* When asking a question, [do not ask to ask](https://dontasktoask.com). -* Avoid the [XY problem](https://xyproblem.info). -* Be as detailed about your problem as possible, including what you are trying - to achieve, what methods you have tried, what the exact results of your - attempts have been, and so on.