Skip to content

Latest commit

 

History

History
120 lines (77 loc) · 5.73 KB

CONTRIBUTING.md

File metadata and controls

120 lines (77 loc) · 5.73 KB
Raw

Contributing to mkeithX.

To foster a positive and inclusive community, MKX SpaceHub™ has established a Code of Conduct for all participants to follow. Please review the summarized guidelines to understand what behaviors are expected and unacceptable.

Core Values

  • Respect: Treat others with kindness, empathy, and understanding.
  • Inclusivity: Embrace diversity of thought, background, and identity.
  • Openness: Encourage honest and constructive communication.
  • Collaboration: Work together towards common goals with mutual respect.

Expected Behavior

  • Be respectful towards others, regardless of differences.
  • Listen actively and considerately to others' perspectives.
  • Provide constructive feedback and criticism.
  • Refrain from engaging in any form of harassment, discrimination, or offensive behavior.

Unacceptable Behavior

  • Offensive comments related to personal characteristics.
  • Harassment, intimidation, or discrimination in any form.
  • Disruptive behavior that hinders productive discussion.
  • Any form of unwelcome attention or advances.

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.

Development process

MKXSpacehub depends on GitHub as its main source of information. All pull requests will be checked by the continuous integration system, GitHub actions.

website_status build_status issues pr lic

Contribute

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your feature or bug fix:
git switch -c <'feature/your-feature-name'>
  1. Make your changes and commit them with descriptive commit messages:
git commit -m 'feat:Add some feature'
  1. Push your changes to your forked repository:
git push -u origin <'feature/your-feature-name'>
  1. Open a pull request (PR) against the main repository's main branch.
  2. Ensure that your PR includes a clear description of the changes made and any relevant information.
  3. Our team will review your PR, provide feedback, and merge it if everything looks good.

Code Conventions

Follow the existing code style and formatting conventions.

Commit Messages

Write clear and concise commit messages and PR descriptions.

Type Description Example Commit message
feat A new API or behavior for the end user. Added a feature to allow users to upload profile pictures.
fix A bug fix for the end user. Resolved issue where login button was not clickable on mobile devices.
docs A change to the website or other Markdown documents in our repo. Updated installation guide with additional troubleshooting steps.
refactor A change to production code that leads to no behavior difference. Refactored code to improve readability and maintainability.
test Adding missing tests, refactoring tests; no production code change. Added unit tests for user authentication module.
chore Upgrading dependencies, releasing new versions, maintenance tasks. Updated package.json with latest dependency versions.
misc Anything else that doesn't change production code, yet is not test or chore. Updated GitHub Actions workflow to include code linting.

More about Conventional Commits.

Pull request

  • Keep your changes focused and atomic, addressing one issue per PR.
  • Write clear and concise commit messages and PR descriptions.
  • Test your changes thoroughly and ensure they don't introduce any regressions.
  • Be respectful and considerate towards other contributors.

Issues

Bugs

You can report issues related to documentation if you find any of the following:

  • Undocumented API
  • Need for elaboration on a particular topic
  • Outdated or incorrect information
  • Formatting or readability improvement

Feature Request

For new feature or suggestion, feel free to submit a feature request

If you discover a bug, have a suggestion, or wish to request a new feature, please feel free to open an issue.

IMPORTANT: For issues related to infrastructure, please visit the Docusaurus website.

Licensing

By contributing to MKEITHX Website, you agree that your contributions will be under its MIT license.