Skip to content

CONTRIBUTION.md

Latest commit

 

History

History
26 lines (22 loc) · 2.39 KB

CONTRIBUTION.md

File metadata and controls

26 lines (22 loc) · 2.39 KB
Raw

Contribution Guidelines

Thank you for considering contributing to our open-source project! We welcome contributions from anyone, whether you're a seasoned developer or just starting out. By following these guidelines, you can help us maintain a welcoming and collaborative environment for everyone involved.

Ways to Contribute

There are several ways you can contribute to our project:

  • Code Contributions: If you're comfortable writing APEX code or building an LWC component, you can help us by fixing bugs, implementing new features, or improving existing ones. Check out the issue tracker in the repository and filter by Category: Apex or Category: LWC tags
  • Documentation: Clear and comprehensive documentation is essential for the project's success. You can contribute by improving our documentation, writing tutorials, or providing examples. You can also check the issue tracker and filter by Category: Documentation tag
  • Bug Reports: If you encounter any bugs while using the project, please report them using the issue tracker. Include relevant details and steps to reproduce the bug. Please use Type: Bug tag to mark your new features
  • Feature Requests: If you have ideas for new features or improvements, feel free to submit a feature request. Explain the feature and its potential benefits clearly. Use Category tags to define what kind of work this issue involves (APEX, Admin, LWC etc.), and use Type: Feature to mark your issues. Consider marking your issue with Type: Enhancement in case it is an improvement of an existing functionality

Getting Started

To start contributing, follow these steps:

  1. Create an issue explaining your idea
  2. Fork the repository to your GitHub account.
  3. Clone the forked repository to your local machine.
  4. Create a new branch for your contributions (use dev branch as origin).
  5. Deploy the code to your own Scratch org
  6. Assign ScoreHub Admin or ScoreHub User permission set group to your user
  7. Run ScoreHubConfig.config() static method to generate basic Measurements and Achievements
  8. Configure necessary Measurements and Achievements
  9. Do necessary changes and test them on your Scratch Org
  10. Commit your changes with a clear and descriptive commit message.
  11. Push your changes to your forked repository.
  12. Submit a pull request (PR) to the dev repository. Use Close keywoard to mark the issue that you've created in the step 1