Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (28 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

40 lines (28 loc) · 1.83 KB

Contributing to NShell

Thank you for considering contributing to NShell! We appreciate your efforts in improving the project. By participating, you agree to follow the guidelines laid out below.

How to Contribute

Reporting Issues

If you encounter a bug or have a question, please report it using the "Issues" tab of the GitHub repository. Provide as much detail as possible about the issue, including:

  • A description of the problem.
  • Steps to reproduce the issue.
  • Expected and actual results.
  • Any relevant logs or error messages.

Submitting Code

We welcome code contributions! To ensure the process is smooth, please follow these steps:

  1. Fork the repository and clone it to your local machine.
  2. Create a new branch for your changes. It's best to name it according to the feature or bug you're working on, e.g., feature/new-feature or fix/fix-issue.
  3. Make your changes and test them thoroughly.
  4. Commit your changes with a clear and concise commit message. Use the present tense (e.g., "fix: fix message", "feat: feature message").
  5. Push your changes to your forked repository.
  6. Create a pull request to the main repository, providing a description of the changes and why they are necessary.

Code Style

Please adhere to the following guidelines when writing code:

  • Use consistent indentation (spaces, not tabs).
  • Write clear, concise, and self-explanatory variable names.
  • Include comments where necessary to explain complex logic.
  • Follow best practices for writing secure and efficient code.

Code Reviews

All pull requests will undergo code review by the maintainers. They may request changes or provide feedback. Please respond promptly to ensure the PR can be merged.

Thank you for your contributions ! <3

Happy coding, and thank you for contributing to NShell ! ヽ(・∀・)ﾉ