Skip to content

Latest commit

 

History

History
79 lines (46 loc) · 5.75 KB

CONTRIBUTING.md

File metadata and controls

79 lines (46 loc) · 5.75 KB
Raw

Contributing

Thank you for considering contributing to SCHub! Before you proceed, we kindly request that you first discuss the changes you wish to make with the owners of this repository. Please create an issue (or discussion) regarding the contribution or reply to an existing issue (or discussion) you wish to address and discuss the changes you plan to make, also you can reach out to us on discord, via linkedin at Jesulayomy, or email. This initial discussion will help ensure that your contribution aligns with the project's goals and prevents any duplication of efforts.

As a contributor to SCHub, please adhere to our code of conduct in all your interactions with the project. We strive to maintain an inclusive and respectful environment for everyone involved.

Pull Request Process

To streamline the process of merging your changes into the main repository, please follow these steps:

  1. Before initiating a build, make sure to remove any unnecessary install or build dependencies.
  2. Update the CHANGELOG.md file to include details of the changes you've made to the project. This includes documenting new environment variables, exposed ports, useful file locations, and any relevant container parameters.
  3. Once you are ready to merge your Pull Request, ensure it contains the text "[Hacktoberfest]" in it's title, then kindly obtain the sign-off of at least one maintainer. You can request a reviewer to merge it on your behalf to the hacktoberfest branch.

We appreciate your cooperation in following this process, as it helps maintain the quality and integrity of the SCHub codebase.

Hacktoberfest Contributions

If you are participating in Hacktoberfest, we welcome your contributions to SCHub. However, please note that we will only accept Pull Requests that meet the following criteria:

  • Addresses an existing issue or bug in the project.
  • Adds a new feature or functionality to the project. (Create an issue first to discuss the feature you intend to add.) New issues must be approved first by a maintainer to avoid rejected PRs.
  • Improves the project's documentation or code quality.

Also ensure you are registered for hacktoberfest:

  1. Register for Hacktoberfest: Head over to the Hacktoberfest website to register. Your contributions to this repository will count towards your Hacktoberfest progress.

  2. Fork the Repository: Start by forking the repository to your GitHub account. Then clone the forked repository to your local machine.

  3. Then proceed to make your changes and create a pull request to the hacktoberfest branch (DO NOT MAKE PRs TO main FOR HACKTOBERFEST).

Code of Conduct

Our Pledge

At SCHub, we are committed to fostering an open and welcoming environment. We pledge to make participation in our project and 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, sexual identity and orientation.

Our Standards

To create a positive environment, we expect the following behaviors from all contributors:

  • Use welcoming language.
  • Show respect for differing viewpoints and experiences.
  • Accept constructive criticism gracefully.
  • Focus on what is best for the community.
  • Demonstrate empathy towards other community members.

Examples of unacceptable behavior include:

  • Usage of sexualized language or imagery, as well as unwelcome sexual attention or advances.
  • Trolling, insulting or derogatory comments, personal or political attacks.
  • Harassment, whether public or private.
  • Publishing others' private information, such as physical or electronic addresses, without explicit permission.
  • Any other conduct that could reasonably be considered inappropriate in a professional setting.

Our Responsibilities

As project maintainers, we are responsible for establishing and enforcing acceptable standards of behavior. We are committed to taking 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 do not align with this Code of Conduct. They may also temporarily or permanently ban any contributor for other behaviors they deem inappropriate, threatening, offensive, or harmful.

Scope

This Code of Conduct applies to all spaces associated with the SCHub project, both online and offline. This includes project spaces and public spaces where an individual is representing the project or its community. Examples of representation include using an official project email address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Project maintainers may further define and clarify the representation of a project.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. All complaints will be reviewed and investigated promptly. The project team is committed to maintaining confidentiality regarding the reporter of any incident. Further details on specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce this 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 (rewritten) from the Contributor Covenant, version 1.4, available at Contribution Convenant.