Skip to content

Latest commit

 

History

History
61 lines (35 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

61 lines (35 loc) · 2.16 KB

Contributing

Thank you for your interest in contribution to this project :-)

Before you get started, please familiarize yourself with the project structure, languages, and coding styles.

Preparations

Note

You need to fork the repository into your user space to make changes and propose them to the upstream repository.

Fork the repository into your namespace using the UI or CLI.

Learn more about

Development Environment

Development in Gitpod

Replace YOURUSERNAME in the URL https://gitpod.io/#https:/YOURUSERNAME/talktometechnology, copy/open the URL and select to continue with GitHub. Inside Gitpod, you can make changes, create a new branch and Pull Request using the GitHub extensions.

Local Development

Clone the forked repository, and replace YOURUSERNAME with your username or namespace.

$ USERNAME="YOURUSERNAME"
$ git clone https:/$USERNAME/talktometechnology && cd talktometechnology

Follow the instructions with local or container environments.

Languages and style guide

The project currently uses static files to render the content, and run client-side JavaScript. HTML, JavaScript and CSS knowledge is recommended for code contributions.

Please follow the existing code style, and avoid changes in Pull Requests, for example indent changes.

Workflows

Please create a new branch for any proposed changes, commit the changes, push the branch, and create a new Pull Request.

$ git checkout -b new-feature

$ git add changedfile newfile

$ git commit -v changedfile newfile -m "Add new feature X

More description or issue references #1"

$ git push -u origin new-feature

Open the URL shown in the server response to create a new Pull Request in the browser.