Skip to content

Latest commit

 

History

History
89 lines (55 loc) · 3.95 KB

CONTRIBUTING.md

File metadata and controls

89 lines (55 loc) · 3.95 KB
Raw

Contributing to Daily

👋 Hi there! The Daily team is excited that you are reading this and are willing to contribute. No need to think big. Even a typo fix might save our day and make you a hero. Every contribution counts! 🔥

Code of Conduct

We have written some ground rules to keep discussion open and inclusive. Please take your time to read and follow our Code of Conduct.

Where to Contribute?

Daily is made out of several repositories. It helps us keep the different services decoupled and deliver new features quickly. A full list of these repositories can be found here with a short explanation about each one. If you are still not sure where the right place is to contribute, ask here by submitting an issue.

Found a Bug?

If you find a bug (sorry for that 😅), you can contribute by submitting an issue. If you are really into it, submit a Pull Request with your fix, we will be grateful forever.

Documentation Never Ends

When it comes to documentation, there is also room for improvement. Together, we can make sure everything is up-to-date and nothing is missing. You can feel free to submit a Pull Request with your documentation changes or even just submit an issue.

Have a Great Idea?

Feel like you know what feature is missing? Share your thoughts with us by submitting an issue. Do you want to make sure your feature is implemented? Submit an issue with your implementation proposal. This will allow us to prevent duplication of work, discuss the details of the implementation and even provide designs, if necessary. Discussing your proposal will make sure that your work will be accepted into the project.

Contribution Guideline

Submitting an Issue

Before submitting your issue, please check that it was not reported already (open or closed). Please provide as many details as possible so we can act as soon as possible.

Submitting a Pull Request

Before submitting a pull request, consider the following guidelines:

  1. To prevent duplication of work, please search for an existing PR (open or closed) that relates to yours.
  2. Make sure there is an issue describing your submission, whether it is a bug fix or a feature. Discussing the issue upfront will make the review process much faster.
  3. Please sign our Contributor License Agreement (CLA). Unfortunately, we cannot accept any contribution without this. Make sure you sign and contribute with the same GitHub account.
  4. Make sure your pull request is addressing only a single concern.

How to submit a pull request?

  1. Fork the relevant repository.
  2. Check out a topic branch for your submission.
  3. Apply your work there. It's fine to have multiple commits. We will make sure to squash it before merging.
  4. Make sure to add appropriate tests which cover your work.
  5. Follow our Coding Rules.
  6. Run the test suite of the repository.
  7. Push your new branch to GitHub.
  8. Submit a pull request to the master branch.

Once everything is done, your work will be live and available to all Daily users.

Coding Rules

Each repository has its own coding rules and formatters to automatically enforce them when running the tests. As a general rule of thumb, we use Airbnb JavaScript style guide for most JavaScript projects.

Commit Messages

We follow Angular's commit message guidelines. This leads to more readable messages and automatic changelog generation.

Once again, thank you for joining our journey and good luck contributing 🙏