Contribution Guide

Contribution Guide

We love to pull requests from everyone! We follow the standard Git workflow of fork -> change -> pull request -> merge -> update fork -> change ... (repeat forever). If you are new to open source, we recommend GitHub's excellent guide on "How to Contribute to Open Source". In addition, please feel free to reach out to any of the maintainers or other community members if you are struggling; we are here to help you learn!

Opening an issue

If you're experiencing an issue with CHAOSS Slack Bot or have a question you'd like help answering, please feel free to open an issue. To help us prevent duplicates, we kindly ask that you briefly search for your problem or question in our issues before opening a new one. Please note that if you open a bug report, we cannot help you until you have provided us with all the relevant information. Respectfully, we do not have the time to try and recreate an error given with minimal or no context, so by providing this information you are helping us help you! Provide descriptions to the best of your ability, and please include screenshots and error logs if applicable.

Development Guide

1. Fork this repo, and then clone it

$ git clone https://github.com/chaoss/chaoss-slack-bot.git
$ cd chaoss-slack-bot
$ git remote add upstream https://github.com/chaoss/chaoss-slack-bot.git

2. Install dependencies

npm install or yarn add

3. For Windows PCs only: Rename the .env.example to .env, and insert your tokens into the quotes. Make sure you include the .env file in your .gitignore file.

4. Create a new branch

$ git checkout -b my-new-branch

5. Make your change(s). We encourage you to write tests.

6. Commit the change(s) with a descriptive commit message (here's a guide for writing good commit messages) and push to your fork. PS: if you’re not familiar with DCO, read the guide on signing off commits below before you come back to this step.

$ git add .
$ git commit -s -m "descriptive commit message"
$ git push -u origin my-new-branch

6. Submit a pull request. At this point, you're waiting on us. We like to at least comment on pull requests within three business days (and, typically, one business day). Once one of our maintainers has had a chance to review your PR, we will either mark it as "needs review" and provide specific feedback on your changes, or we will go ahead and complete the pull request.

Signing-off on Commits

To contribute to this project, you must agree to the Developer Certificate of Origin by the CHAOSS charter for each commit you make. The DCO is a simple statement that you, as a contributor, have the legal right to make the contribution. To signify that you agree to the DCO for contributions, you simply add a line to each of your git commit messages:

Signed-off-by: Jane Smith <[email protected]>

This can be easily done by using the -s flag when using git commit. For example:

$ git commit -s -m "my commit message w/signoff"

To ensure all your commits are signed, you have to configure git properly by editing your global .gitconfig

$ git config --global user.name "John Doe" 
$ git config --global user.email [email protected]

Any pull requests containing commits that are not signed off will not be eligible for merge until the commits have been signed off. Keeping in sync with the Chaoss Slack Bot Repository Remember to sync your fork with the main branch regularly. To do this: Make sure to be in the root folder of the project and the branch should be master branch and type

$ git remote add upstream https://github.com/chaoss/chaoss-slack-bot.git

Now you have your upstream setup in your local machine, whenever you need to make a new branch for making changes make sure your main branch is in sync with the main repository, to do this, make sure to be in the main branch and type:

$ git pull upstream master
$ git push origin master