Skip to content

Latest commit

 

History

History
43 lines (24 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

43 lines (24 loc) · 2.51 KB

Contributing to PINAC-Workspace 🚀

We love your input! We want to make contributing to PINAC as easy and transparent as possible, whether it's:

  • Reporting a bug 🐛
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing a new feature 🥳
  • Becoming a maintainer ✨

For every small improvement you contribute, you will be helping push the frontiers of what's possible with PINAC-Workspace 😃!

Getting Started

💠 Star the Repo: Show your appreciation and stay updated with project activity by starring this repository.

💠 Fork it: Create your copy of the repository by clicking the "Fork" button. This allows you to make changes without affecting the original project.

💠 Clone the Code: Download your forked repository to your local machine using Git.

💠 Create your feature branch: Create a new branch for your specific contribution. Use a descriptive branch name that reflects your changes.

💠 Ready, Set, Go! : Make your changes to the code. We are flexible on code style and formatting, but please ensure your code is well-documented and readable.

💠 Pull Request Your Masterpiece: Once you're happy with your work, push your changes to your forked repository and create a pull request to the main repository. This will notify us of your contribution and allow us to review your changes.

Additional Information:

  • Testing: We encourage you to write unit tests for any new code you add. This helps ensure the quality and stability of the project.
  • Documentation: If you make any changes to the code or functionality, please update the relevant documentation accordingly. This helps other users understand how to use the project effectively.
  • Community: We are committed to fostering a welcoming and inclusive community. We ask that all contributors treat each other with respect and courtesy.

PR recommendations

To allow your work to be integrated as seamlessly as possible, we advise you to:

✅ Verify your PR is up-to-date with master branch. If your PR is behind you can update your code by clicking the 'Update branch' button or by running git pull locally.

✅ Reduce changes to the absolute minimum required for your bug fix or feature addition. "It is not daily increase but daily decrease, hack away the unessential. The closer to the source, the less wastage there is." — Bruce Lee

Thank you ❤️ for your interest in contributing to this project! We appreciate your time and effort and are excited to see what you can create.