Skip to content

Latest commit

 

History

History
59 lines (34 loc) · 3.12 KB

contribution.md

File metadata and controls

59 lines (34 loc) · 3.12 KB

Navigation

Contribution Guidelines

We appreciate your interest in contributing to the Overture! Please take the time to read and follow these guidelines before submitting your contributions. By participating in this project, you are expected to abide by the Code of Conduct. Please take the time to read it carefully before contributing.

Running score from Source Code

To contribute to score, you'll need to run the application from the source code. Here's how you can do that:

  1. Clone the Repository: First, clone the score repository to your local machine using git clone https://github.com/overture-stack/SCORE.git.

  2. Install Dependencies: Navigate to the cloned directory and install all required dependencies.

  3. Run the Application Locally: After installing the dependencies, start the application locally. This usually involves running a command like npm start or python manage.py runserver, again depending on the language and framework used.

  4. Test Your Changes: Before submitting a pull request, make sure to test your changes thoroughly. Run the automated tests (if available) and perform manual testing to ensure that your contribution does not introduce regressions.

Issues and Feature Requests

Before opening a new issue or feature request, please check if a similar one already exists. If so, please add a comment to the existing issue instead of creating a new one. When submitting an issue or feature request, please include a detailed description of the problem or feature you would like to see, along with any relevant code, error messages, or screenshots. This will help us better understand the issue and respond more efficiently.

Pull Requests

We welcome and encourage pull requests from the community. To submit a pull request, please follow these steps:

  1. Fork the Repository: Fork the score repository on GitHub.
  2. Clone Your Fork: Clone your forked repository to your local machine.
  3. Create a New Branch: Create a new branch for your changes.
  4. Make Your Changes: Implement your changes and commit them to your branch.
  5. Push Your Changes: Push your changes to your forked repository.
  6. Submit a Pull Request: Open a pull request against the main repository.

Please ensure your code adheres to the following guidelines before submission:

  • The code should be well-documented and readable.
  • The code should be tested.
  • Include a clear description of the changes made and the reason for the changes in the pull request.

For any questions or discussions regarding your pull request, please refer to the GitHub issues system or join our Slack channel for further assistance.

We use GitHub issues and pull requests for communication-related to code changes. For general discussion, feel free to join our Slack channel.

Thank you for contributing to Overture-Stack!

Navigation