diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..a90ff9f --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,43 @@ +# Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment include: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery and unwelcome sexual attention or advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at s56gkgkq@void.black. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c282e81 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,59 @@ +# Contributing to mini loader + +First off, thank you for considering contributing to mini loader! It's people like you that make mini loader such a great tool. + +## Code of Conduct + +This project and everyone participating in it is governed by the [mini loader Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to s56gkgkq@void.black. + +## How Can I Contribute? + +### Reporting Bugs + +This section guides you through submitting a bug report for mini loader. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports. + +**Before Submitting A Bug Report** + +- Ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/morten-olsen/mini-loader/issues). +- If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring. + +### Suggesting Enhancements + +This section guides you through submitting an enhancement suggestion for mini loader, including completely new features and minor improvements to existing functionality. + +**Before Submitting An Enhancement Suggestion** + +- Check if the enhancement has already been suggested under [Issues](https://github.com/morten-olsen/mini-loader/issues). +- If it hasn't, create a new issue and provide a concise description of the enhancement with as much detail as possible. + +### Your First Code Contribution + +Unsure where to begin contributing to mini loader? You can start by looking through `beginner` and `help-wanted` issues: + +- Beginner issues - issues which should only require a few lines of code, and a test or two. +- Help wanted issues - issues which should be a bit more involved than `beginner` issues. + +### Pull Requests + +- Fill in the required template +- Do not include issue numbers in the PR title +- Follow the coding style used throughout the project +- Include appropriate test coverage. New features should include new tests. +- Document new code based on the [Documentation Styleguide](#documentation-styleguide) + +## Documentation Styleguide + +Use this style guide for documentation: + +- Use Markdown +- Reference methods and classes in markdown backticks. For example, `ClassName.methodName` +- Document new code or add comments in code to explain parts that might be confusing. + +## Use a Consistent Coding Style + +* 2 spaces for indentation rather than tabs +* You can try running `pnpm run test:lint` for style unification + +## License + +By contributing to mini loader, you agree that your contributions will be licensed under its GPL-3 License.