Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
102 lines (61 loc) · 3.35 KB

CONTRIBUTING.md

File metadata and controls

102 lines (61 loc) · 3.35 KB

Contributing to Sendexa Servers

Thank you for considering contributing to the Sendexa Servers project! Your contributions help improve the quality and functionality of the project, and we truly appreciate your efforts.

Please follow the guidelines below to ensure a smooth and consistent contribution process.

How to Contribute

1. Fork the Repository

Start by forking the Sendexa Servers repository to your GitHub account. This allows you to make changes to your own copy of the project without affecting the main repository.

  • Click the Fork button at the top-right of the repository page.

2. Clone the Repository

After forking the repository, clone your fork to your local machine:

git clone https://github.com/<your-username>/sendexa-servers.git
cd sendexa-servers

3. Create a Branch

It's best practice to create a new branch for each feature or fix you work on. This keeps things organized and allows us to review each change independently.

git checkout -b feature-name

4. Make Changes

Now, make the necessary changes to the code or documentation. Please ensure that your code adheres to the project's style and conventions. If you're adding new features, make sure they are well-documented.

  • Follow the existing structure and naming conventions.
  • Write clear and concise commit messages.

5. Commit Your Changes

Once your changes are complete, commit them with a clear and descriptive message:

git add .
git commit -m "Describe your changes"

6. Push Your Changes

Push your changes to your forked repository on GitHub:

git push origin feature-name

7. Open a Pull Request

Now, go to your GitHub repository and open a Pull Request (PR) from your branch to the main branch of the Sendexa Servers repository. Provide a description of your changes, and make sure to reference any relevant issues.

Code of Conduct

By contributing to this project, you agree to adhere to the following Code of Conduct, which ensures that the project remains a respectful and welcoming space for all participants.

Reporting Issues

If you find a bug or have an idea for an improvement, please feel free to open an issue:

  1. Go to the Issues tab in the repository.
  2. Click New Issue.
  3. Provide a clear description of the issue or suggestion, and include relevant details such as:
    • Steps to reproduce (if applicable).
    • Expected behavior.
    • Actual behavior.

Pull Request Guidelines

  • Ensure that the code is well-documented and includes tests where applicable.
  • Follow the existing project style and best practices.
  • Run the existing test suite to confirm your changes don’t break any functionality.
  • If your pull request fixes a bug or adds a feature, please reference the relevant issue in your commit message or PR description.

Additional Notes

  • This project follows Semantic Versioning, so please be mindful of version updates when contributing.
  • For large changes or additions, it’s a good idea to discuss the implementation details before starting your work by opening an issue or discussing it in the PR.

Thank You!

Your contributions are highly valued, and we appreciate your help in improving Sendexa Servers!