Skip to content

Latest commit

 

History

History
78 lines (56 loc) · 2.47 KB

contributing.md

File metadata and controls

78 lines (56 loc) · 2.47 KB

Contributing Guidelines

Thank you for considering contributing to the Shork project! We appreciate your help and want to make sure that the process is clear and smooth for everyone. By contributing to this project, you agree to follow these guidelines as well as the terms outlined in the Shork License.

How to Contribute

1. Fork the Repository

  1. Fork the repository to your own GitHub account.
  2. Clone the forked repository to your local machine.

2. Create a Branch

  1. Create a new branch from the main branch for your work. 
    git checkout -b feature/your-feature-name

3. Make Changes

  1. Ensure your changes are focused and relevant to the purpose of the project.
  2. Follow the project's coding standards and style guides.

4. Test Your Changes

  1. If the project includes tests, run all tests to make sure your changes don’t break anything. 
    npm test

5. Commit Your Changes

  1. Write clear, concise commit messages. 
    git commit -m "Description of your changes"

6. Push to Your Fork

  1. Push your branch to your forked repository. 
    git push origin feature/your-feature-name

7. Create a Pull Request

  1. Open a pull request from your forked repository's branch to the main branch of the Shork repository.
  2. Provide a clear and detailed description of what you’ve done and why.

Code of Conduct

Be Respectful

  1. Treat others with respect and kindness.
  2. Be considerate of different viewpoints and experiences.

Be Constructive

  1. Provide constructive feedback.
  2. Be open to receiving feedback on your contributions.

Reporting Issues

Bug Reports

  1. Check if the issue has already been reported.
  2. Provide a detailed description of the bug, including steps to reproduce it.
  3. Include any relevant logs or error messages.

Feature Requests

  1. Describe the feature and its benefits.
  2. Explain why the feature is important or useful.

Security Vulnerabilities

Confidential Reporting

  1. Report security vulnerabilities confidentially in accordance with our SECURITY.md policy.
  2. Do not publicly disclose vulnerabilities until they have been addressed.

Contact

If you have any questions or need further guidance, please reach out to the project maintainers.

Thank you for your contributions and for helping make Shork better!

By following these guidelines, you help maintain the integrity and quality of the Shork project. We look forward to collaborating with you!