Contributing to CONNECTeD

Are you interested in adding more features to CONNECTeD? Follow the detailed guidelines below in order to make your contribution to CONNECTeD the right way!

STEP 1: Start by forking the CONNECTeD repository to your GitHub account. After you have forked the repository, you should be able to see it in your collection of repositories.

STEP 2: If you are working on an existing issue, assign the issue to yourself on GitHub so others know you are working on it. If you are working on a new feature, create an issue and briefly explain the feature you will be adding. Assign the new issue to yourself. You can also create and add labels to these issues, and add issues to certain milestones.

STEP 3: The right way to modify an existing feature or add a new feature to the application would be by creating a separate branch for each of the features you work on. As you work on a particular feature, make sure you commit your local changes through the branch (for the specific feature), and aren't making changes directly to the master branch.

STEP 4: While coding a new feature, you might have questions regarding the implementations of the application.

• In order to better understand the implementation details and the thinking process refer to Technical Architecture Overview.
• Additionally, if you would like to familiarize yourself with the basics of Sequelize, the concept of cookies and how CONNECTeD uses them you could refer to Sequelize, Cookies.
• The Tech Stack section in the Wiki will be a handy tool for you while you code, and it will ensure that your code is consistent, structured and concise.

STEP 5: Once you're done coding, push the files that you have made changes to from your branch. This is a simple 3 step procedure from the GitBash terminal.
git add <filename>
git commit -m'YOUR COMMIT MESSAGE'
git push
More information about git branching and other basic git functionalities can be found at Learn Git.

STEP 6: After you have pushed your branch and have made a commit for a feature, make sure to click on the 'Compare and Pull Request' option to create a new pull request. In your pull request description:

• Explain briefly the changes you have made to the code base
• If you made design changes then add a screenshot of your design.
• Have at least one person review your code and make an required changes.
• Resolve conflicts (if any)

Once your code is code reviewed, merge it with master.